Package software.amazon.awssdk.services.dynamodb.model

Class ExportTableToPointInTimeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
software.amazon.awssdk.services.dynamodb.model.ExportTableToPointInTimeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ExportTableToPointInTimeRequest extends DynamoDbRequest implements ToCopyableBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>

  • Method Details

    • tableArn

      public final String tableArn()

      The Amazon Resource Name (ARN) associated with the table to export.

      Returns:
      The Amazon Resource Name (ARN) associated with the table to export.

    • exportTime

      public final Instant exportTime()

      Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

      Returns:
      Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

    • clientToken

      public final String clientToken()

      Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

      If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

      Returns:
      Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

      A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

      If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

    • s3Bucket

      public final String s3Bucket()

      The name of the Amazon S3 bucket to export the snapshot to.

      Returns:
      The name of the Amazon S3 bucket to export the snapshot to.

    • s3BucketOwner

      public final String s3BucketOwner()

      The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

      S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

      Returns:
      The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

      S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

    • s3Prefix

      public final String s3Prefix()

      The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

      Returns:
      The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

    • s3SseAlgorithm

      public final S3SseAlgorithm s3SseAlgorithm()

      Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

      • AES256 - server-side encryption with Amazon S3 managed keys

      • KMS - server-side encryption with KMS managed keys

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

      Returns:
      Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

      • AES256 - server-side encryption with Amazon S3 managed keys

      • KMS - server-side encryption with KMS managed keys

      See Also:

    • s3SseAlgorithmAsString

      public final String s3SseAlgorithmAsString()

      Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

      • AES256 - server-side encryption with Amazon S3 managed keys

      • KMS - server-side encryption with KMS managed keys

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

      Returns:
      Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

      • AES256 - server-side encryption with Amazon S3 managed keys

      • KMS - server-side encryption with KMS managed keys

      See Also:

    • s3SseKmsKeyId

      public final String s3SseKmsKeyId()

      The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

      Returns:
      The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

    • exportFormat

      public final ExportFormat exportFormat()

      The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

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

      Returns:
      The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
      See Also:

    • exportFormatAsString

      public final String exportFormatAsString()

      The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

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

      Returns:
      The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
      See Also:

    • exportType

      public final ExportType exportType()

      Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

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

      Returns:
      Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
      See Also:

    • exportTypeAsString

      public final String exportTypeAsString()

      Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

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

      Returns:
      Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.
      See Also:

    • incrementalExportSpecification

      public final IncrementalExportSpecification incrementalExportSpecification()

      Optional object containing the parameters specific to an incremental export.

      Returns:
      Optional object containing the parameters specific to an incremental export.

    • toBuilder

      public ExportTableToPointInTimeRequest.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<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static ExportTableToPointInTimeRequest.Builder builder()

    • serializableBuilderClass

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