Class BulkOperationDescription

java.lang.Object
software.amazon.awssdk.services.dynamodb.model.BulkOperationDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BulkOperationDescription.Builder,BulkOperationDescription>
@Generated("software.amazon.awssdk:codegen") public final class BulkOperationDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BulkOperationDescription.Builder,BulkOperationDescription>

Contains detailed information about a bulk operation.

See Also:

  • Method Details

    • bulkOperationArn

      public final String bulkOperationArn()

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

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

    • bulkOperationStatus

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, bulkOperationStatus will return BulkOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bulkOperationStatusAsString().

      Returns:
      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.

      See Also:

    • bulkOperationStatusAsString

      public final String bulkOperationStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, bulkOperationStatus will return BulkOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bulkOperationStatusAsString().

      Returns:
      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.

      See Also:

    • hasTableDetails

      public final boolean hasTableDetails()
      For responses, this returns true if the service returned a value for the TableDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tableDetails

      public final List<BulkOperationTableDetail> tableDetails()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTableDetails() method.

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

    • clientToken

      public final String clientToken()

      The idempotency token associated with the start request.

      Returns:
      The idempotency token associated with the start request.

    • inputS3Configuration

      public final InputS3Configuration inputS3Configuration()

      The Amazon S3 input configuration associated with the bulk operation.

      Returns:
      The Amazon S3 input configuration associated with the bulk operation.

    • outputS3Configuration

      public final OutputS3Configuration outputS3Configuration()

      The Amazon S3 output configuration associated with the bulk operation.

      Returns:
      The Amazon S3 output configuration associated with the bulk operation.

    • startTime

      public final Instant startTime()

      The time when DynamoDB accepted the start request.

      Returns:
      The time when DynamoDB accepted the start request.

    • endTime

      public final Instant endTime()

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

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

    • processedItemCount

      public final Long processedItemCount()

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

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

    • processedInputBytes

      public final Long processedInputBytes()

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

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

    • totalInputBytes

      public final Long totalInputBytes()

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

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

    • hasBulkOperationUsage

      public final boolean hasBulkOperationUsage()
      For responses, this returns true if the service returned a value for the BulkOperationUsage property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • bulkOperationUsage

      public final List<BulkOperationUsage> bulkOperationUsage()

      Usage information for the table and its indexes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBulkOperationUsage() method.

      Returns:
      Usage information for the table and its indexes.

    • failedItemCount

      public final 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.

      Returns:
      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.

    • failureCode

      public final 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.

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

    • failureMessage

      public final 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.

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

    • maxWriteRequestUnits

      public final Long maxWriteRequestUnits()

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

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

    • performanceTier

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, performanceTier will return BulkOperationPerformanceTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceTierAsString().

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

    • performanceTierAsString

      public final String performanceTierAsString()

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

      If the service returns an enum value that is not available in the current SDK version, performanceTier will return BulkOperationPerformanceTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from performanceTierAsString().

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

    • toBuilder

      public BulkOperationDescription.Builder 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 interface ToCopyableBuilder<BulkOperationDescription.Builder,BulkOperationDescription>
      Returns:
      a builder for type T

    • builder

      public static BulkOperationDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BulkOperationDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.