Interface BulkOperationDescription.Builder

All Superinterfaces:
Buildable, CopyableBuilder<BulkOperationDescription.Builder,BulkOperationDescription>, SdkBuilder<BulkOperationDescription.Builder,BulkOperationDescription>, SdkPojo
Enclosing class:
BulkOperationDescription
@Mutable @NotThreadSafe public static interface BulkOperationDescription.Builder extends SdkPojo, CopyableBuilder<BulkOperationDescription.Builder,BulkOperationDescription>

  • Method Details

    • bulkOperationArn

      BulkOperationDescription.Builder bulkOperationArn(String bulkOperationArn)

      The Amazon Resource Name (ARN) of the bulk operation.

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

    • bulkOperationStatus

      BulkOperationDescription.Builder bulkOperationStatus(String bulkOperationStatus)

      The current status of the bulk operation can be one of the following values:

      IN_PROGRESS

      DynamoDB is processing the input.

      COMPLETED

      The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.

      COMPLETED_WITH_ERRORS

      The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.

      CANCELLING

      DynamoDB accepted a cancellation request and is stopping the operation.

      CANCELLED

      DynamoDB stopped the operation after a cancellation request.

      FAILED

      The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

      Parameters:
      bulkOperationStatus - The current status of the bulk operation can be one of the following values:

      IN_PROGRESS

      DynamoDB is processing the input.

      COMPLETED

      The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.

      COMPLETED_WITH_ERRORS

      The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.

      CANCELLING

      DynamoDB accepted a cancellation request and is stopping the operation.

      CANCELLED

      DynamoDB stopped the operation after a cancellation request.

      FAILED

      The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

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

    • bulkOperationStatus

      BulkOperationDescription.Builder bulkOperationStatus(BulkOperationStatus bulkOperationStatus)

      The current status of the bulk operation can be one of the following values:

      IN_PROGRESS

      DynamoDB is processing the input.

      COMPLETED

      The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.

      COMPLETED_WITH_ERRORS

      The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.

      CANCELLING

      DynamoDB accepted a cancellation request and is stopping the operation.

      CANCELLED

      DynamoDB stopped the operation after a cancellation request.

      FAILED

      The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

      Parameters:
      bulkOperationStatus - The current status of the bulk operation can be one of the following values:

      IN_PROGRESS

      DynamoDB is processing the input.

      COMPLETED

      The bulk operation finished without parsing or validation errors. Condition-check failures do not cause the operation to complete with errors.

      COMPLETED_WITH_ERRORS

      The bulk operation finished, but DynamoDB couldn't process at least one input item because of a parsing or validation error. When you enable ERROR output, DynamoDB writes the details to the configured Amazon S3 output location.

      CANCELLING

      DynamoDB accepted a cancellation request and is stopping the operation.

      CANCELLED

      DynamoDB stopped the operation after a cancellation request.

      FAILED

      The bulk operation failed. DynamoDB might write some items before the operation reaches this status. See FailureCode and FailureMessage for details.

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

    • tableDetails

      BulkOperationDescription.Builder tableDetails(Collection<BulkOperationTableDetail> tableDetails)

      A list containing identifying information for the table targeted by the bulk operation.

      Parameters:
      tableDetails - A list containing identifying information for the table targeted by the bulk operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableDetails

      BulkOperationDescription.Builder tableDetails(BulkOperationTableDetail... tableDetails)

      A list containing identifying information for the table targeted by the bulk operation.

      Parameters:
      tableDetails - A list containing identifying information for the table targeted by the bulk operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tableDetails

      BulkOperationDescription.Builder tableDetails(Consumer<BulkOperationTableDetail.Builder>... tableDetails)

      A list containing identifying information for the table targeted by the bulk operation.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tableDetails(List<BulkOperationTableDetail>).

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

    • clientToken

      BulkOperationDescription.Builder clientToken(String clientToken)

      The idempotency token associated with the start request.

      Parameters:
      clientToken - The idempotency token associated with the start request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputS3Configuration

      BulkOperationDescription.Builder inputS3Configuration(InputS3Configuration inputS3Configuration)

      The Amazon S3 input configuration associated with the bulk operation.

      Parameters:
      inputS3Configuration - The Amazon S3 input configuration associated with the bulk operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputS3Configuration

      default BulkOperationDescription.Builder inputS3Configuration(Consumer<InputS3Configuration.Builder> inputS3Configuration)

      The Amazon S3 input configuration associated with the bulk operation.

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

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

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

    • outputS3Configuration

      BulkOperationDescription.Builder outputS3Configuration(OutputS3Configuration outputS3Configuration)

      The Amazon S3 output configuration associated with the bulk operation.

      Parameters:
      outputS3Configuration - The Amazon S3 output configuration associated with the bulk operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3Configuration

      default BulkOperationDescription.Builder outputS3Configuration(Consumer<OutputS3Configuration.Builder> outputS3Configuration)

      The Amazon S3 output configuration associated with the bulk operation.

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

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

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

    • startTime

      BulkOperationDescription.Builder startTime(Instant startTime)

      The time when DynamoDB accepted the start request.

      Parameters:
      startTime - The time when DynamoDB accepted the start request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      BulkOperationDescription.Builder endTime(Instant endTime)

      The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.

      Parameters:
      endTime - The time when the operation reached a terminal status. DynamoDB omits this value while the operation remains in progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processedItemCount

      BulkOperationDescription.Builder processedItemCount(Long processedItemCount)

      The number of input items that DynamoDB has processed. This count includes successful writes, parsing or validation failures, and condition-check failures.

      Parameters:
      processedItemCount - The number of input items that DynamoDB has processed. This count includes successful writes, parsing or validation failures, and condition-check failures.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • processedInputBytes

      BulkOperationDescription.Builder processedInputBytes(Long processedInputBytes)

      The number of bytes that DynamoDB has read from the Amazon S3 input objects.

      Parameters:
      processedInputBytes - The number of bytes that DynamoDB has read from the Amazon S3 input objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalInputBytes

      BulkOperationDescription.Builder totalInputBytes(Long totalInputBytes)

      The total size, in bytes, of the Amazon S3 input objects. DynamoDB omits this value until the initial input-size calculation completes.

      Parameters:
      totalInputBytes - The total size, in bytes, of the Amazon S3 input objects. DynamoDB omits this value until the initial input-size calculation completes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bulkOperationUsage

      BulkOperationDescription.Builder bulkOperationUsage(Collection<BulkOperationUsage> bulkOperationUsage)

      Usage information for the table and its indexes.

      Parameters:
      bulkOperationUsage - Usage information for the table and its indexes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bulkOperationUsage

      BulkOperationDescription.Builder bulkOperationUsage(BulkOperationUsage... bulkOperationUsage)

      Usage information for the table and its indexes.

      Parameters:
      bulkOperationUsage - Usage information for the table and its indexes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bulkOperationUsage

      BulkOperationDescription.Builder bulkOperationUsage(Consumer<BulkOperationUsage.Builder>... bulkOperationUsage)

      Usage information for the table and its indexes.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bulkOperationUsage(List<BulkOperationUsage>).

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

    • failedItemCount

      BulkOperationDescription.Builder failedItemCount(Long failedItemCount)

      The number of processed input items that failed because of parsing or validation errors. This count is included in ProcessedItemCount. Condition-check failures do not increase this count.

      Parameters:
      failedItemCount - The number of processed input items that failed because of parsing or validation errors. This count is included in ProcessedItemCount. Condition-check failures do not increase this count.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureCode

      BulkOperationDescription.Builder failureCode(String failureCode)

      A code that identifies why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

      Parameters:
      failureCode - A code that identifies why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureMessage

      BulkOperationDescription.Builder failureMessage(String failureMessage)

      A message that describes why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.

      Parameters:
      failureMessage - A message that describes why the bulk operation failed or was cancelled. DynamoDB returns this value only when BulkOperationStatus is FAILED or CANCELLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxWriteRequestUnits

      BulkOperationDescription.Builder maxWriteRequestUnits(Long maxWriteRequestUnits)

      The maximum write request unit rate configured for the bulk operation.

      Parameters:
      maxWriteRequestUnits - The maximum write request unit rate configured for the bulk operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • performanceTier

      BulkOperationDescription.Builder performanceTier(String performanceTier)

      The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD.

      Parameters:
      performanceTier - The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • performanceTier

      BulkOperationDescription.Builder performanceTier(BulkOperationPerformanceTier performanceTier)

      The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD.

      Parameters:
      performanceTier - The performance tier selected for the bulk operation. Valid values are STANDARD and ACCELERATED. If the start request omitted this value, DynamoDB uses STANDARD .
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: