Package software.amazon.awssdk.services.securityhub.model

Class ClassificationResult

java.lang.Object

software.amazon.awssdk.services.securityhub.model.ClassificationResult

All Implemented Interfaces:

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

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

Details about the sensitive data that was detected on the resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClassificationResult.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	additionalOccurrences()	Indicates whether there are additional occurrences of sensitive data that are not included in the finding.
static ClassificationResult.Builder	builder()
CustomDataIdentifiersResult	customDataIdentifiers()	Provides details about sensitive data that was identified based on customer-defined configuration.
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 that the finding applies to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
List<SensitiveDataResult>	sensitiveData()	Provides details about sensitive data that was identified based on built-in configuration.
static Class<? extends ClassificationResult.Builder>	serializableBuilderClass()
Long	sizeClassified()	The total size in bytes of the affected data.
ClassificationStatus	status()	The current status of the sensitive data detection.
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

mimeType

public final String mimeType()

The type of content that the finding applies to.

Returns:

The type of content that the finding applies to.

sizeClassified

public final Long sizeClassified()

The total size in bytes of the affected data.

Returns:

The total size in bytes of the affected data.

additionalOccurrences

public final Boolean additionalOccurrences()

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

Returns:

Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.

status

public final ClassificationStatus status()

The current status of the sensitive data detection.

Returns:

The current status of the sensitive data detection.

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<SensitiveDataResult> sensitiveData()

Provides details about sensitive data that was identified based on built-in configuration.

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:

Provides details about sensitive data that was identified based on built-in configuration.

customDataIdentifiers

public final CustomDataIdentifiersResult customDataIdentifiers()

Provides details about sensitive data that was identified based on customer-defined configuration.

Returns:

Provides details about sensitive data that was identified based on customer-defined configuration.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo