Package software.amazon.awssdk.services.customerprofiles.model

Class GetSegmentSnapshotResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

software.amazon.awssdk.services.customerprofiles.model.GetSegmentSnapshotResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSegmentSnapshotResponse.Builder,GetSegmentSnapshotResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetSegmentSnapshotResponse
extends CustomerProfilesResponse
implements ToCopyableBuilder<GetSegmentSnapshotResponse.Builder,GetSegmentSnapshotResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSegmentSnapshotResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetSegmentSnapshotResponse.Builder	builder()
DataFormat	dataFormat()	The format in which the segment will be exported.
String	dataFormatAsString()	The format in which the segment will be exported.
String	destinationUri()	The destination to which the segment will be exported.
String	encryptionKey()	The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetSegmentSnapshotResponse.Builder>	serializableBuilderClass()
String	snapshotId()	The unique identifier of the segment snapshot.
SegmentSnapshotStatus	status()	The status of the asynchronous job for exporting the segment snapshot.
String	statusAsString()	The status of the asynchronous job for exporting the segment snapshot.
String	statusMessage()	The status message of the asynchronous job for exporting the segment snapshot.
GetSegmentSnapshotResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse

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

snapshotId

public final String snapshotId()

The unique identifier of the segment snapshot.

Returns:

The unique identifier of the segment snapshot.

status

public final SegmentSnapshotStatus status()

The status of the asynchronous job for exporting the segment snapshot.

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

Returns:

The status of the asynchronous job for exporting the segment snapshot.

See Also:

SegmentSnapshotStatus

statusAsString

public final String statusAsString()

The status of the asynchronous job for exporting the segment snapshot.

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

Returns:

The status of the asynchronous job for exporting the segment snapshot.

See Also:

SegmentSnapshotStatus

statusMessage

public final String statusMessage()

The status message of the asynchronous job for exporting the segment snapshot.

Returns:

The status message of the asynchronous job for exporting the segment snapshot.

dataFormat

public final DataFormat dataFormat()

The format in which the segment will be exported.

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

Returns:

The format in which the segment will be exported.

See Also:

DataFormat

dataFormatAsString

public final String dataFormatAsString()

The format in which the segment will be exported.

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

Returns:

The format in which the segment will be exported.

See Also:

DataFormat

encryptionKey

public final String encryptionKey()

The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

Returns:

The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

Returns:

The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

destinationUri

public final String destinationUri()

The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.

Returns:

The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.

toBuilder

public GetSegmentSnapshotResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSegmentSnapshotResponse.Builder,GetSegmentSnapshotResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSegmentSnapshotResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo