software.amazon.awssdk.services.macie2.model

Class GetSensitiveDataOccurrencesAvailabilityResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.macie2.model.Macie2Response

software.amazon.awssdk.services.macie2.model.GetSensitiveDataOccurrencesAvailabilityResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSensitiveDataOccurrencesAvailabilityResponse.Builder,GetSensitiveDataOccurrencesAvailabilityResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetSensitiveDataOccurrencesAvailabilityResponse
extends Macie2Response
implements ToCopyableBuilder<GetSensitiveDataOccurrencesAvailabilityResponse.Builder,GetSensitiveDataOccurrencesAvailabilityResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSensitiveDataOccurrencesAvailabilityResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetSensitiveDataOccurrencesAvailabilityResponse.Builder	builder()
AvailabilityCode	code() Specifies whether occurrences of sensitive data can be retrieved for the finding.
String	codeAsString() Specifies whether occurrences of sensitive data can be retrieved for the finding.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReasons() For responses, this returns true if the service returned a value for the Reasons property.
List<UnavailabilityReasonCode>	reasons() Specifies why occurrences of sensitive data can't be retrieved for the finding.
List<String>	reasonsAsStrings() Specifies why occurrences of sensitive data can't be retrieved for the finding.
List<SdkField<?>>	sdkFields()
static Class<? extends GetSensitiveDataOccurrencesAvailabilityResponse.Builder>	serializableBuilderClass()
GetSensitiveDataOccurrencesAvailabilityResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.macie2.model.Macie2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

code

public final AvailabilityCode code()

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.

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

Returns:

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.

See Also:

AvailabilityCode

codeAsString

public final String codeAsString()

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.

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

Returns:

Specifies whether occurrences of sensitive data can be retrieved for the finding. Possible values are: AVAILABLE, the sensitive data can be retrieved; and, UNAVAILABLE, the sensitive data can't be retrieved. If this value is UNAVAILABLE, the reasons array indicates why the data can't be retrieved.

See Also:

AvailabilityCode

reasons

public final List<UnavailabilityReasonCode> reasons()

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

• INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.

• OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

• OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

• UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.

• UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.

This value is null if sensitive data can be retrieved for 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 hasReasons() method.

Returns:

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

• INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.

• OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

• OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

• UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.

• UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.

This value is null if sensitive data can be retrieved for the finding.

hasReasons

public final boolean hasReasons()

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

reasonsAsStrings

public final List<String> reasonsAsStrings()

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

• INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.

• OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

• OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

• UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.

• UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.

This value is null if sensitive data can be retrieved for 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 hasReasons() method.

Returns:

Specifies why occurrences of sensitive data can't be retrieved for the finding. Possible values are:

• INVALID_CLASSIFICATION_RESULT - Amazon Macie can't verify the location of the sensitive data to retrieve. There isn't a corresponding sensitive data discovery result for the finding. Or the sensitive data discovery result specified by the ClassificationDetails.detailedResultsLocation field of the finding isn't available, is malformed or corrupted, or uses an unsupported storage format.

• OBJECT_EXCEEDS_SIZE_QUOTA - The storage size of the affected S3 object exceeds the size quota for retrieving occurrences of sensitive data.

• OBJECT_UNAVAILABLE - The affected S3 object isn't available. The object might have been renamed, moved, or deleted. Or the object was changed after Macie created the finding.

• UNSUPPORTED_FINDING_TYPE - The specified finding isn't a sensitive data finding.

• UNSUPPORTED_OBJECT_TYPE - The affected S3 object uses a file or storage format that Macie doesn't support for retrieving occurrences of sensitive data.

This value is null if sensitive data can be retrieved for the finding.

toBuilder

public GetSensitiveDataOccurrencesAvailabilityResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSensitiveDataOccurrencesAvailabilityResponse.Builder,GetSensitiveDataOccurrencesAvailabilityResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSensitiveDataOccurrencesAvailabilityResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSensitiveDataOccurrencesAvailabilityResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo