Class StartBulkPutItemsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest
software.amazon.awssdk.services.dynamodb.model.StartBulkPutItemsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartBulkPutItemsRequest.Builder,StartBulkPutItemsRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartBulkPutItemsRequest extends DynamoDbRequest implements ToCopyableBuilder<StartBulkPutItemsRequest.Builder,StartBulkPutItemsRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that ensures the bulk operation starts no more than one time. During the 8 hours after the initial request, repeated requests that use the same token and parameters return the same bulk operation. If a request reuses the token with different parameters, DynamoDB returns an IdempotentParameterMismatchException. If you omit the token, an Amazon Web Services SDK automatically generates one.

      Returns:
      A unique, case-sensitive identifier that ensures the bulk operation starts no more than one time. During the 8 hours after the initial request, repeated requests that use the same token and parameters return the same bulk operation. If a request reuses the token with different parameters, DynamoDB returns an IdempotentParameterMismatchException. If you omit the token, an Amazon Web Services SDK automatically generates one.

    • inputS3Configuration

      public final InputS3Configuration inputS3Configuration()

      The Amazon S3 location, data format, and compression settings for the input objects.

      Returns:
      The Amazon S3 location, data format, and compression settings for the input objects.

    • outputS3Configuration

      public final OutputS3Configuration outputS3Configuration()

      The Amazon S3 location, encryption settings, and output types for the bulk operation.

      Returns:
      The Amazon S3 location, encryption settings, and output types for the bulk operation.

    • tableName

      public final String tableName()

      The name or ARN of the existing DynamoDB table that receives the items.

      Returns:
      The name or ARN of the existing DynamoDB table that receives the items.

    • maxWriteRequestUnits

      public final Long maxWriteRequestUnits()

      The maximum rate, in write request units per second, at which the bulk operation attempts to write. The value must be at least 1,024. With this setting, you limit only the bulk operation; the table's provisioned or on-demand capacity settings don't change. The actual write rate can be lower.

      Returns:
      The maximum rate, in write request units per second, at which the bulk operation attempts to write. The value must be at least 1,024. With this setting, you limit only the bulk operation; the table's provisioned or on-demand capacity settings don't change. The actual write rate can be lower.

    • performanceTier

      public final BulkOperationPerformanceTier performanceTier()

      The performance tier for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation 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 for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation uses STANDARD.
      See Also:

    • performanceTierAsString

      public final String performanceTierAsString()

      The performance tier for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation 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 for the bulk operation. Valid values are STANDARD and ACCELERATED. If you don't specify a value, the operation uses STANDARD.
      See Also:

    • toBuilder

      public StartBulkPutItemsRequest.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<StartBulkPutItemsRequest.Builder,StartBulkPutItemsRequest>
      Specified by:
      toBuilder in class DynamoDbRequest
      Returns:
      a builder for type T

    • builder

      public static StartBulkPutItemsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.