Class Detection
- java.lang.Object
-
- software.amazon.awssdk.services.macie2.model.Detection
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Detection.Builder,Detection>
@Generated("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 Description static interfaceDetection.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()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.Builderbuilder()Longcount()The total number of occurrences of the sensitive data.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The unique identifier for the custom data identifier or managed data identifier that detected the sensitive data.Stringname()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()Booleansuppressed()Specifies whether occurrences of this type of sensitive data are excluded (true) or included (false) in the bucket's sensitivity score.Detection.BuildertoBuilder()StringtoString()Returns a string representation of this object.DataIdentifierTypetype()The type of data identifier that detected the sensitive data.StringtypeAsString()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,
typewill returnDataIdentifierType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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,
typewill returnDataIdentifierType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- 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:
toBuilderin interfaceToCopyableBuilder<Detection.Builder,Detection>
-
builder
public static Detection.Builder builder()
-
serializableBuilderClass
public static Class<? extends Detection.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-