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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ExportTableToPointInTimeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ExportTableToPointInTimeRequest.Builder
builder()
String
clientToken()
Providing aClientToken
makes the call toExportTableToPointInTimeInput
idempotent, meaning that multiple identical calls have the same effect as one single call.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
ExportFormat
exportFormat()
The format for the exported data.String
exportFormatAsString()
The format for the exported data.Instant
exportTime()
Time in the past from which to export table data, counted in seconds from the start of the Unix epoch.ExportType
exportType()
Choice of whether to execute as a full export or incremental export.String
exportTypeAsString()
Choice of whether to execute as a full export or incremental export.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
IncrementalExportSpecification
incrementalExportSpecification()
Optional object containing the parameters specific to an incremental export.String
s3Bucket()
The name of the Amazon S3 bucket to export the snapshot to.String
s3BucketOwner()
The ID of the Amazon Web Services account that owns the bucket the export will be stored in.String
s3Prefix()
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.S3SseAlgorithm
s3SseAlgorithm()
Type of encryption used on the bucket where export data will be stored.String
s3SseAlgorithmAsString()
Type of encryption used on the bucket where export data will be stored.String
s3SseKmsKeyId()
The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).List<SdkField<?>>
sdkFields()
static Class<? extends ExportTableToPointInTimeRequest.Builder>
serializableBuilderClass()
String
tableArn()
The Amazon Resource Name (ARN) associated with the table to export.ExportTableToPointInTimeRequest.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
-
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 toExportTableToPointInTimeInput
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 toExportTableToPointInTimeInput
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 returnS3SseAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3SseAlgorithmAsString()
.- 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:
S3SseAlgorithm
-
-
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 returnS3SseAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available froms3SseAlgorithmAsString()
.- 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:
S3SseAlgorithm
-
-
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
areDYNAMODB_JSON
orION
.If the service returns an enum value that is not available in the current SDK version,
exportFormat
will returnExportFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportFormatAsString()
.- Returns:
- The format for the exported data. Valid values for
ExportFormat
areDYNAMODB_JSON
orION
. - See Also:
ExportFormat
-
exportFormatAsString
public final String exportFormatAsString()
The format for the exported data. Valid values for
ExportFormat
areDYNAMODB_JSON
orION
.If the service returns an enum value that is not available in the current SDK version,
exportFormat
will returnExportFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportFormatAsString()
.- Returns:
- The format for the exported data. Valid values for
ExportFormat
areDYNAMODB_JSON
orION
. - See Also:
ExportFormat
-
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 returnExportType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportTypeAsString()
.- 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:
ExportType
-
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 returnExportType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportTypeAsString()
.- 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:
ExportType
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExportTableToPointInTimeRequest.Builder,ExportTableToPointInTimeRequest>
- Specified by:
toBuilder
in classDynamoDbRequest
-
builder
public static ExportTableToPointInTimeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExportTableToPointInTimeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-