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

Interface ExportDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ExportDescription.Builder,ExportDescription>, SdkBuilder<ExportDescription.Builder,ExportDescription>, SdkPojo
Enclosing class:
ExportDescription
public static interface ExportDescription.Builder extends SdkPojo, CopyableBuilder<ExportDescription.Builder,ExportDescription>

  • Method Details

    • exportArn

      ExportDescription.Builder exportArn(String exportArn)

      The Amazon Resource Name (ARN) of the table export.

      Parameters:
      exportArn - The Amazon Resource Name (ARN) of the table export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportStatus

      ExportDescription.Builder exportStatus(String exportStatus)

      Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

      Parameters:
      exportStatus - Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exportStatus

      ExportDescription.Builder exportStatus(ExportStatus exportStatus)

      Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

      Parameters:
      exportStatus - Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTime

      ExportDescription.Builder startTime(Instant startTime)

      The time at which the export task began.

      Parameters:
      startTime - The time at which the export task began.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      ExportDescription.Builder endTime(Instant endTime)

      The time at which the export task completed.

      Parameters:
      endTime - The time at which the export task completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportManifest

      ExportDescription.Builder exportManifest(String exportManifest)

      The name of the manifest file for the export task.

      Parameters:
      exportManifest - The name of the manifest file for the export task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableArn

      ExportDescription.Builder tableArn(String tableArn)

      The Amazon Resource Name (ARN) of the table that was exported.

      Parameters:
      tableArn - The Amazon Resource Name (ARN) of the table that was exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableId

      ExportDescription.Builder tableId(String tableId)

      Unique ID of the table that was exported.

      Parameters:
      tableId - Unique ID of the table that was exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportTime

      ExportDescription.Builder exportTime(Instant exportTime)

      Point in time from which table data was exported.

      Parameters:
      exportTime - Point in time from which table data was exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      ExportDescription.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • s3Bucket

      ExportDescription.Builder s3Bucket(String s3Bucket)

      The name of the Amazon S3 bucket containing the export.

      Parameters:
      s3Bucket - The name of the Amazon S3 bucket containing the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3BucketOwner

      ExportDescription.Builder s3BucketOwner(String s3BucketOwner)

      The ID of the Amazon Web Services account that owns the bucket containing the export.

      Parameters:
      s3BucketOwner - The ID of the Amazon Web Services account that owns the bucket containing the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3Prefix

      ExportDescription.Builder s3Prefix(String s3Prefix)

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

      Parameters:
      s3Prefix - The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3SseAlgorithm

      ExportDescription.Builder s3SseAlgorithm(String 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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3SseAlgorithm

      ExportDescription.Builder s3SseAlgorithm(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

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • s3SseKmsKeyId

      ExportDescription.Builder s3SseKmsKeyId(String s3SseKmsKeyId)

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

      Parameters:
      s3SseKmsKeyId - The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureCode

      ExportDescription.Builder failureCode(String failureCode)

      Status code for the result of the failed export.

      Parameters:
      failureCode - Status code for the result of the failed export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureMessage

      ExportDescription.Builder failureMessage(String failureMessage)

      Export failure reason description.

      Parameters:
      failureMessage - Export failure reason description.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportFormat

      ExportDescription.Builder exportFormat(String exportFormat)

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

      Parameters:
      exportFormat - The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exportFormat

      ExportDescription.Builder exportFormat(ExportFormat exportFormat)

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

      Parameters:
      exportFormat - The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • billedSizeBytes

      ExportDescription.Builder billedSizeBytes(Long billedSizeBytes)

      The billable size of the table export.

      Parameters:
      billedSizeBytes - The billable size of the table export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • itemCount

      ExportDescription.Builder itemCount(Long itemCount)

      The number of items exported.

      Parameters:
      itemCount - The number of items exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exportType

      ExportDescription.Builder exportType(String exportType)

      The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

      Parameters:
      exportType - The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exportType

      ExportDescription.Builder exportType(ExportType exportType)

      The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

      Parameters:
      exportType - The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • incrementalExportSpecification

      ExportDescription.Builder incrementalExportSpecification(IncrementalExportSpecification incrementalExportSpecification)

      Optional object containing the parameters specific to an incremental export.

      Parameters:
      incrementalExportSpecification - Optional object containing the parameters specific to an incremental export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incrementalExportSpecification

      default ExportDescription.Builder incrementalExportSpecification(Consumer<IncrementalExportSpecification.Builder> incrementalExportSpecification)

      Optional object containing the parameters specific to an incremental export.

      This is a convenience method that creates an instance of the IncrementalExportSpecification.Builder avoiding the need to create one manually via IncrementalExportSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to incrementalExportSpecification(IncrementalExportSpecification).

      Parameters:
      incrementalExportSpecification - a consumer that will call methods on IncrementalExportSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: