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() Returns true if the SensitiveData property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 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 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 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 boolean hasSensitiveData()

Returns true if the SensitiveData property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

sensitiveData

public 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.

You can use hasSensitiveData() to see if a value was sent in this field.

Returns:

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

sizeClassified

public 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo