software.amazon.awssdk.services.macie2.model

Class ClassificationResult

java.lang.Object

software.amazon.awssdk.services.macie2.model.ClassificationResult

All Implemented Interfaces:

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

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

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassificationResult.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	additionalOccurrences() Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object.
static ClassificationResult.Builder	builder()
CustomDataIdentifiers	customDataIdentifiers() The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSensitiveData() For responses, this returns true if the service returned a value for the SensitiveData property.
String	mimeType() The type of content, as a MIME type, that the finding applies to.
List<SdkField<?>>	sdkFields()
List<SensitiveDataItem>	sensitiveData() The category, types, and number of occurrences of the sensitive data that produced the finding.
static Class<? extends ClassificationResult.Builder>	serializableBuilderClass()
Long	sizeClassified() The total size, in bytes, of the data that the finding applies to.
ClassificationResultStatus	status() The status of the finding.
ClassificationResult.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

additionalOccurrences

public final Boolean additionalOccurrences()

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

Returns:

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

customDataIdentifiers

public final CustomDataIdentifiers customDataIdentifiers()

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

Returns:

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

mimeType

public final String mimeType()

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

Returns:

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

hasSensitiveData

public final boolean hasSensitiveData()

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

sensitiveData

public final List<SensitiveDataItem> sensitiveData()

The category, types, and number of occurrences of the sensitive data that produced the finding.

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

Returns:

The category, types, and number of occurrences of the sensitive data that produced the finding.

sizeClassified

public final Long sizeClassified()

The total size, in bytes, of the data that the finding applies to.

Returns:

The total size, in bytes, of the data that the finding applies to.

status

public final ClassificationResultStatus status()

The status of the finding.

Returns:

The status of the finding.

toBuilder

public ClassificationResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClassificationResult.Builder,ClassificationResult>

builder

public static ClassificationResult.Builder builder()

serializableBuilderClass

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