software.amazon.awssdk.services.macie2.model

Class Detection

java.lang.Object

software.amazon.awssdk.services.macie2.model.Detection

All Implemented Interfaces:

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

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

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for the bucket. The information also specifies the custom data identifier or managed data identifier that detected the data. This information is available only if automated sensitive data discovery is currently enabled for your account.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Detection.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data.
static Detection.Builder	builder()
Long	count() The total number of occurrences of the sensitive data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data.
String	name() The name of the custom data identifier or managed data identifier that detected the sensitive data.
List<SdkField<?>>	sdkFields()
static Class<? extends Detection.Builder>	serializableBuilderClass()
Boolean	suppressed() Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.
Detection.Builder	toBuilder()
String	toString() Returns a string representation of this object.
DataIdentifierType	type() The type of data identifier that detected the sensitive data.
String	typeAsString() The type of data identifier that detected the sensitive data.

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

arn

public final String arn()

If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

Returns:

If the sensitive data was detected by a custom data identifier, the Amazon Resource Name (ARN) of the custom data identifier that detected the data. Otherwise, this value is null.

count

public final Long count()

The total number of occurrences of the sensitive data.

Returns:

The total number of occurrences of the sensitive data.

id

public final String id()

The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

Returns:

The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data. For additional details about a specified managed data identifier, see Using managed data identifiers in the Amazon Macie User Guide.

name

public final String name()

The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

Returns:

The name of the custom data identifier or managed data identifier that detected the sensitive data. For a managed data identifier, this value is the same as the unique identifier (id).

suppressed

public final Boolean suppressed()

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

Returns:

Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.

type

public final DataIdentifierType type()

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

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

Returns:

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

See Also:

DataIdentifierType

typeAsString

public final String typeAsString()

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

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

Returns:

The type of data identifier that detected the sensitive data. Possible values are: CUSTOM, for a custom data identifier; and, MANAGED, for a managed data identifier.

See Also:

DataIdentifierType

toBuilder

public Detection.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Detection.Builder,Detection>

builder

public static Detection.Builder builder()

serializableBuilderClass

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