Class ExportDescription
- java.lang.Object
-
- software.amazon.awssdk.services.dynamodb.model.ExportDescription
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ExportDescription.Builder,ExportDescription>
@Generated("software.amazon.awssdk:codegen") public final class ExportDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExportDescription.Builder,ExportDescription>
Represents the properties of the exported table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ExportDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Long
billedSizeBytes()
The billable size of the table export.static ExportDescription.Builder
builder()
String
clientToken()
The client token that was provided for the export task.Instant
endTime()
The time at which the export task completed.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
exportArn()
The Amazon Resource Name (ARN) of the table export.ExportFormat
exportFormat()
The format of the exported data.String
exportFormatAsString()
The format of the exported data.String
exportManifest()
The name of the manifest file for the export task.ExportStatus
exportStatus()
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.String
exportStatusAsString()
Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.Instant
exportTime()
Point in time from which table data was exported.ExportType
exportType()
The type of export that was performed.String
exportTypeAsString()
The type of export that was performed.String
failureCode()
Status code for the result of the failed export.String
failureMessage()
Export failure reason description.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
IncrementalExportSpecification
incrementalExportSpecification()
Optional object containing the parameters specific to an incremental export.Long
itemCount()
The number of items exported.String
s3Bucket()
The name of the Amazon S3 bucket containing the export.String
s3BucketOwner()
The ID of the Amazon Web Services account that owns the bucket containing the export.String
s3Prefix()
The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.S3SseAlgorithm
s3SseAlgorithm()
Type of encryption used on the bucket where export data is stored.String
s3SseAlgorithmAsString()
Type of encryption used on the bucket where export data is stored.String
s3SseKmsKeyId()
The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).List<SdkField<?>>
sdkFields()
static Class<? extends ExportDescription.Builder>
serializableBuilderClass()
Instant
startTime()
The time at which the export task began.String
tableArn()
The Amazon Resource Name (ARN) of the table that was exported.String
tableId()
Unique ID of the table that was exported.ExportDescription.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
exportArn
public final String exportArn()
The Amazon Resource Name (ARN) of the table export.
- Returns:
- The Amazon Resource Name (ARN) of the table export.
-
exportStatus
public final ExportStatus 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:
ExportStatus
-
exportStatusAsString
public final String 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:
ExportStatus
-
startTime
public final Instant startTime()
The time at which the export task began.
- Returns:
- The time at which the export task began.
-
endTime
public final Instant endTime()
The time at which the export task completed.
- Returns:
- The time at which the export task completed.
-
exportManifest
public final String exportManifest()
The name of the manifest file for the export task.
- Returns:
- The name of the manifest file for the export task.
-
tableArn
public final String 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
public final String tableId()
Unique ID of the table that was exported.
- Returns:
- Unique ID of the table that was exported.
-
exportTime
public final Instant exportTime()
Point in time from which table data was exported.
- Returns:
- Point in time from which table data was exported.
-
clientToken
public final String 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
public final String s3Bucket()
The name of the Amazon S3 bucket containing the export.
- Returns:
- The name of the Amazon S3 bucket containing the export.
-
s3BucketOwner
public final String 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
public final String 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
public final S3SseAlgorithm 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:
S3SseAlgorithm
-
-
s3SseAlgorithmAsString
public final String 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:
S3SseAlgorithm
-
-
s3SseKmsKeyId
public final String 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
public final String failureCode()
Status code for the result of the failed export.
- Returns:
- Status code for the result of the failed export.
-
failureMessage
public final String failureMessage()
Export failure reason description.
- Returns:
- Export failure reason description.
-
exportFormat
public final ExportFormat 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:
ExportFormat
-
exportFormatAsString
public final String 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:
ExportFormat
-
billedSizeBytes
public final Long billedSizeBytes()
The billable size of the table export.
- Returns:
- The billable size of the table export.
-
itemCount
public final Long itemCount()
The number of items exported.
- Returns:
- The number of items exported.
-
exportType
public final ExportType 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:
ExportType
-
exportTypeAsString
public final String 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:
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 ExportDescription.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ExportDescription.Builder,ExportDescription>
-
builder
public static ExportDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends ExportDescription.Builder> serializableBuilderClass()
-
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.
-
-