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

Class CreateSegmentSnapshotRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesRequest

software.amazon.awssdk.services.customerprofiles.model.CreateSegmentSnapshotRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSegmentSnapshotRequest.Builder,CreateSegmentSnapshotRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSegmentSnapshotRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateSegmentSnapshotRequest.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	domainName()	The unique name of the domain.
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()
String	segmentDefinitionName()	The name of the segment definition used in this snapshot request.
static Class<? extends CreateSegmentSnapshotRequest.Builder>	serializableBuilderClass()
CreateSegmentSnapshotRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

domainName

public final String domainName()

The unique name of the domain.

Returns:

The unique name of the domain.

segmentDefinitionName

public final String segmentDefinitionName()

The name of the segment definition used in this snapshot request.

Returns:

The name of the segment definition used in this snapshot request.

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 CreateSegmentSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSegmentSnapshotRequest.Builder,CreateSegmentSnapshotRequest>

Specified by:

toBuilder in class CustomerProfilesRequest

builder

public static CreateSegmentSnapshotRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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