Interface BatchWriteItemRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<BatchWriteItemRequest.Builder,
,BatchWriteItemRequest> DynamoDbRequest.Builder
,SdkBuilder<BatchWriteItemRequest.Builder,
,BatchWriteItemRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
BatchWriteItemRequest
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestItems
(Map<String, ? extends Collection<WriteRequest>> requestItems) A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (DeleteRequest
orPutRequest
).returnConsumedCapacity
(String returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.returnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.returnItemCollectionMetrics
(String returnItemCollectionMetrics) Determines whether item collection metrics are returned.returnItemCollectionMetrics
(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
requestItems
BatchWriteItemRequest.Builder requestItems(Map<String, ? extends Collection<WriteRequest>> requestItems) A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (
DeleteRequest
orPutRequest
). Each element in the map consists of the following:-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
subelement:-
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
-
-
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
subelement:-
Item
- A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with aValidationException
exception.If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
-
- Parameters:
requestItems
- A map of one or more table names or table ARNs and, for each table, a list of operations to be performed (DeleteRequest
orPutRequest
). Each element in the map consists of the following:-
DeleteRequest
- Perform aDeleteItem
operation on the specified item. The item to be deleted is identified by aKey
subelement:-
Key
- A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
-
-
PutRequest
- Perform aPutItem
operation on the specified item. The item to be put is identified by anItem
subelement:-
Item
- A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with aValidationException
exception.If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
returnConsumedCapacity
Sets the value of the ReturnConsumedCapacity property for this object.- Parameters:
returnConsumedCapacity
- The new value for the ReturnConsumedCapacity property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
returnConsumedCapacity
Sets the value of the ReturnConsumedCapacity property for this object.- Parameters:
returnConsumedCapacity
- The new value for the ReturnConsumedCapacity property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
returnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
returnItemCollectionMetrics
BatchWriteItemRequest.Builder returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
BatchWriteItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
BatchWriteItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-