software.amazon.awssdk.services.macie2.model

Class GetSensitiveDataOccurrencesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSensitiveDataOccurrencesResponse.Builder,GetSensitiveDataOccurrencesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSensitiveDataOccurrencesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetSensitiveDataOccurrencesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	error() If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSensitiveDataOccurrences() For responses, this returns true if the service returned a value for the SensitiveDataOccurrences property.
List<SdkField<?>>	sdkFields()
Map<String,List<DetectedDataDetails>>	sensitiveDataOccurrences() A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.
static Class<? extends GetSensitiveDataOccurrencesResponse.Builder>	serializableBuilderClass()
RevealRequestStatus	status() The status of the request to retrieve occurrences of sensitive data reported by the finding.
String	statusAsString() The status of the request to retrieve occurrences of sensitive data reported by the finding.
GetSensitiveDataOccurrencesResponse.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

error

public final String error()

If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.

Returns:

If an error occurred when Amazon Macie attempted to retrieve occurrences of sensitive data reported by the finding, a description of the error that occurred. This value is null if the status (status) of the request is PROCESSING or SUCCESS.

hasSensitiveDataOccurrences

public final boolean hasSensitiveDataOccurrences()

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

sensitiveDataOccurrences

public final Map<String,List<DetectedDataDetails>> sensitiveDataOccurrences()

A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.

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

Returns:

A map that specifies 1-100 types of sensitive data reported by the finding and, for each type, 1-10 occurrences of sensitive data.

status

public final RevealRequestStatus status()

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

• ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.

• PROCESSING - Macie is processing the request.

• SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.

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

Returns:

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

• ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.

• PROCESSING - Macie is processing the request.

• SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.

See Also:

RevealRequestStatus

statusAsString

public final String statusAsString()

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

• ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.

• PROCESSING - Macie is processing the request.

• SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.

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

Returns:

The status of the request to retrieve occurrences of sensitive data reported by the finding. Possible values are:

• ERROR - An error occurred when Amazon Macie attempted to locate, retrieve, or encrypt the sensitive data. The error value indicates the nature of the error that occurred.

• PROCESSING - Macie is processing the request.

• SUCCESS - Macie successfully located, retrieved, and encrypted the sensitive data.

See Also:

RevealRequestStatus

toBuilder

public GetSensitiveDataOccurrencesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSensitiveDataOccurrencesResponse.Builder,GetSensitiveDataOccurrencesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetSensitiveDataOccurrencesResponse.Builder builder()

serializableBuilderClass

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