Class ExportDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ExportDescription.Builder,
ExportDescription>
Represents the properties of the exported table.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
The billable size of the table export.static ExportDescription.Builder
builder()
final String
The client token that was provided for the export task.final Instant
endTime()
The time at which the export task completed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the table export.final ExportFormat
The format of the exported data.final String
The format of the exported data.final String
The name of the manifest file for the export task.final ExportStatus
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.final String
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.final Instant
Point in time from which table data was exported.final ExportType
The type of export that was performed.final String
The type of export that was performed.final String
Status code for the result of the failed export.final String
Export failure reason description.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
Optional object containing the parameters specific to an incremental export.final Long
The number of items exported.final String
s3Bucket()
The name of the Amazon S3 bucket containing the export.final String
The ID of the Amazon Web Services account that owns the bucket containing the export.final String
s3Prefix()
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.final S3SseAlgorithm
Type of encryption used on the bucket where export data is stored.final String
Type of encryption used on the bucket where export data is stored.final String
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).static Class
<? extends ExportDescription.Builder> final Instant
The time at which the export task began.final String
tableArn()
The Amazon Resource Name (ARN) of the table that was exported.final String
tableId()
Unique ID of the table that was exported.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
exportArn
The Amazon Resource Name (ARN) of the table export.
- Returns:
- The Amazon Resource Name (ARN) of the table export.
-
exportStatus
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
If the service returns an enum value that is not available in the current SDK version,
exportStatus
will returnExportStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportStatusAsString()
.- Returns:
- Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
- See Also:
-
exportStatusAsString
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
If the service returns an enum value that is not available in the current SDK version,
exportStatus
will returnExportStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexportStatusAsString()
.- Returns:
- Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
- See Also:
-
startTime
The time at which the export task began.
- Returns:
- The time at which the export task began.
-
endTime
The time at which the export task completed.
- Returns:
- The time at which the export task completed.
-
exportManifest
The name of the manifest file for the export task.
- Returns:
- The name of the manifest file for the export task.
-
tableArn
The Amazon Resource Name (ARN) of the table that was exported.
- Returns:
- The Amazon Resource Name (ARN) of the table that was exported.
-
tableId
Unique ID of the table that was exported.
- Returns:
- Unique ID of the table that was exported.
-
exportTime
Point in time from which table data was exported.
- Returns:
- Point in time from which table data was exported.
-
clientToken
The client token that was provided for the export task. A client token makes calls to
ExportTableToPointInTimeInput
idempotent, meaning that multiple identical calls have the same effect as one single call.- Returns:
- The client token that was provided for the export task. A client token makes calls to
ExportTableToPointInTimeInput
idempotent, meaning that multiple identical calls have the same effect as one single call.
-
s3Bucket
The name of the Amazon S3 bucket containing the export.
- Returns:
- The name of the Amazon S3 bucket containing the export.
-
s3BucketOwner
The ID of the Amazon Web Services account that owns the bucket containing the export.
- Returns:
- The ID of the Amazon Web Services account that owns the bucket containing the export.
-
s3Prefix
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
- Returns:
- The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
-
s3SseAlgorithm
Type of encryption used on the bucket where export data is 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 is 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
Type of encryption used on the bucket where export data is 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 is 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
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
- Returns:
- The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
-
failureCode
Status code for the result of the failed export.
- Returns:
- Status code for the result of the failed export.
-
failureMessage
Export failure reason description.
- Returns:
- Export failure reason description.
-
exportFormat
The format of 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 of the exported data. Valid values for
ExportFormat
areDYNAMODB_JSON
orION
. - See Also:
-
exportFormatAsString
The format of 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 of the exported data. Valid values for
ExportFormat
areDYNAMODB_JSON
orION
. - See Also:
-
billedSizeBytes
The billable size of the table export.
- Returns:
- The billable size of the table export.
-
itemCount
The number of items exported.
- Returns:
- The number of items exported.
-
exportType
The type of export that was performed. Valid values are
FULL_EXPORT
orINCREMENTAL_EXPORT
.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:
- The type of export that was performed. Valid values are
FULL_EXPORT
orINCREMENTAL_EXPORT
. - See Also:
-
exportTypeAsString
The type of export that was performed. Valid values are
FULL_EXPORT
orINCREMENTAL_EXPORT
.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:
- The type of export that was performed. Valid values are
FULL_EXPORT
orINCREMENTAL_EXPORT
. - See Also:
-
incrementalExportSpecification
Optional object containing the parameters specific to an incremental export.
- Returns:
- Optional object containing the parameters specific to an incremental export.
-
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 interfaceToCopyableBuilder<ExportDescription.Builder,
ExportDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-