java.lang.Object
- software.amazon.awssdk.services.macie2.model.Occurrences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Occurrences.Builder,Occurrences>
```
@Generated("software.amazon.awssdk:codegen")
public final class Occurrences
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Occurrences.Builder,Occurrences>
```
Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Occurrences.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Occurrences.Builder`	`builder()`
`List<Cell>`	`cells()`	An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCells()`	For responses, this returns true if the service returned a value for the Cells property.
`int`	`hashCode()`
`boolean`	`hasLineRanges()`	For responses, this returns true if the service returned a value for the LineRanges property.
`boolean`	`hasOffsetRanges()`	For responses, this returns true if the service returned a value for the OffsetRanges property.
`boolean`	`hasPages()`	For responses, this returns true if the service returned a value for the Pages property.
`boolean`	`hasRecords()`	For responses, this returns true if the service returned a value for the Records property.
`List<Range>`	`lineRanges()`	An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.
`List<Range>`	`offsetRanges()`	Reserved for future use.
`List<Page>`	`pages()`	An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file.
`List<Record>`	`records()`	An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Occurrences.Builder>`	`serializableBuilderClass()`
`Occurrences.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasCells
```
public final boolean hasCells()
```
    For responses, this returns true if the service returned a value for the Cells property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - cells
```
public final List<Cell> cells()
```
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.
    
    Each Cell object specifies a cell or field that contains the sensitive data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCells() method.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.
    
    Each Cell object specifies a cell or field that contains the sensitive data.
  - hasLineRanges
```
public final boolean hasLineRanges()
```
    For responses, this returns true if the service returned a value for the LineRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - lineRanges
```
public final List<Range> lineRanges()
```
    An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLineRanges() method.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.
    
    This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.
  - hasOffsetRanges
```
public final boolean hasOffsetRanges()
```
    For responses, this returns true if the service returned a value for the OffsetRanges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - offsetRanges
```
public final List<Range> offsetRanges()
```
    Reserved for future use.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOffsetRanges() method.
    
    Returns:
    
    Reserved for future use.
  - hasPages
```
public final boolean hasPages()
```
    For responses, this returns true if the service returned a value for the Pages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - pages
```
public final List<Page> pages()
```
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.
    
    Each Page object specifies a page that contains the sensitive data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPages() method.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.
    
    Each Page object specifies a page that contains the sensitive data.
  - hasRecords
```
public final boolean hasRecords()
```
    For responses, this returns true if the service returned a value for the Records property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - records
```
public final List<Record> records()
```
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.
    
    For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecords() method.
    
    Returns:
    
    An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.
    
    For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.
  - toBuilder
```
public Occurrences.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Occurrences.Builder,Occurrences>
  - builder
```
public static Occurrences.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Occurrences.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Occurrences

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasCells

cells

hasLineRanges

lineRanges

hasOffsetRanges

offsetRanges

hasPages

pages

hasRecords

records

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields