software.amazon.awssdk.services.macie2.model

Class SensitiveDataItem

java.lang.Object

software.amazon.awssdk.services.macie2.model.SensitiveDataItem

All Implemented Interfaces:

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

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

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SensitiveDataItem.Builder

Method Summary

Modifier and Type	Method and Description
static SensitiveDataItem.Builder	builder()
SensitiveDataItemCategory	category() The category of sensitive data that was detected.
String	categoryAsString() The category of sensitive data that was detected.
List<DefaultDetection>	detections() An array of objects, one for each type of sensitive data that was detected.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetections() For responses, this returns true if the service returned a value for the Detections property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends SensitiveDataItem.Builder>	serializableBuilderClass()
SensitiveDataItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	totalCount() The total number of occurrences of the sensitive data that was detected.

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

category

public final SensitiveDataItemCategory category()

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

If the service returns an enum value that is not available in the current SDK version, category will return SensitiveDataItemCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

See Also:

SensitiveDataItemCategory

categoryAsString

public final String categoryAsString()

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

If the service returns an enum value that is not available in the current SDK version, category will return SensitiveDataItemCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryAsString().

Returns:

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

See Also:

SensitiveDataItemCategory

hasDetections

public final boolean hasDetections()

For responses, this returns true if the service returned a value for the Detections 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.

detections

public final List<DefaultDetection> detections()

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

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 hasDetections() method.

Returns:

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

totalCount

public final Long totalCount()

The total number of occurrences of the sensitive data that was detected.

Returns:

The total number of occurrences of the sensitive data that was detected.

toBuilder

public SensitiveDataItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SensitiveDataItem.Builder,SensitiveDataItem>

builder

public static SensitiveDataItem.Builder builder()

serializableBuilderClass

public static Class<? extends SensitiveDataItem.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