software.amazon.awssdk.services.securityhub.model

Class Occurrences

java.lang.Object

software.amazon.awssdk.services.securityhub.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>

The detected occurrences of sensitive data.

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() Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
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() Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file.
List<Range>	offsetRanges() Occurrences of sensitive data detected in a binary text file.
List<Page>	pages() Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
List<Record>	records() Occurrences of sensitive data in an Apache Avro object container or an 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

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

Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

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:

Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.

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

Occurrences of sensitive data detected in a binary text file.

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:

Occurrences of sensitive data detected in a binary text file.

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

Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.

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:

Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.

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

Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.

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:

Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.

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

Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.

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:

Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) 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 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