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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateSegmentSnapshotRequest.Builder,CreateSegmentSnapshotRequest>
      Specified by:
      toBuilder in class CustomerProfilesRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.