software.amazon.awssdk.services.macie2.model

Class Occurrences

java.lang.Object

software.amazon.awssdk.services.macie2.model.Occurrences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Occurrences.Builder,Occurrences>

@Generated(value="software.amazon.awssdk:codegen")
public final class Occurrences
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Occurrences.Builder,Occurrences>

Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Occurrences.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the Cells property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasLineRanges() Returns true if the LineRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasOffsetRanges() Returns true if the OffsetRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasPages() Returns true if the Pages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasRecords() Returns true if the Records property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<Range>	lineRanges() An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file.
List<Range>	offsetRanges() An array of objects, one for each occurrence of sensitive data in a binary text file.
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 or Apache Parquet 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 boolean hasCells()

Returns true if the Cells property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

cells

public List<Cell> cells()

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCells() to see if a value was sent in this field.

Returns:

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.

hasLineRanges

public boolean hasLineRanges()

Returns true if the LineRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

lineRanges

public List<Range> lineRanges()

An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasLineRanges() to see if a value was sent in this field.

Returns:

An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.

hasOffsetRanges

public boolean hasOffsetRanges()

Returns true if the OffsetRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

offsetRanges

public List<Range> offsetRanges()

An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.

This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasOffsetRanges() to see if a value was sent in this field.

Returns:

An array of objects, one for each occurrence of sensitive data in a binary text file. Each object specifies the position of the data relative to the beginning of the file.

This value is typically null. For binary text files, Amazon Macie adds location data to a lineRanges.Range or Page object, depending on the file type.

hasPages

public boolean hasPages()

Returns true if the Pages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

pages

public List<Page> pages()

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPages() to see if a value was sent in this field.

Returns:

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.

hasRecords

public boolean hasRecords()

Returns true if the Records property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

records

public List<Record> records()

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRecords() to see if a value was sent in this field.

Returns:

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the record index and the path to the field in the record that contains the data. This value is null for all other types of files.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo