Cloneable, ReadLimitInfo, ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>@Generated("software.amazon.awssdk:codegen") public class BatchWriteItemRequest extends AmazonWebServiceRequest implements ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>
Represents the input of a BatchWriteItem operation.
| Modifier and Type | Class | Description |
|---|---|---|
static interface |
BatchWriteItemRequest.Builder |
NOOP| Modifier and Type | Method | Description |
|---|---|---|
static BatchWriteItemRequest.Builder |
builder() |
|
boolean |
equals(Object obj) |
|
int |
hashCode() |
|
Map<String,List<WriteRequest>> |
requestItems() |
A map of one or more table names and, for each table, a list of operations to be performed (
DeleteRequest or PutRequest). |
String |
returnConsumedCapacity() |
|
String |
returnItemCollectionMetrics() |
Determines whether item collection metrics are returned.
|
static Class<? extends BatchWriteItemRequest.Builder> |
serializableBuilderClass() |
|
BatchWriteItemRequest.Builder |
toBuilder() |
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeoutpublic Map<String,List<WriteRequest>> requestItems()
A map of one or more table names and, for each table, a list of operations to be performed (
DeleteRequest or PutRequest). Each element in the map consists of the following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be
deleted is identified by a Key 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 a PutItem operation on the specified item. The item to be put is
identified by an Item 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 will be rejected
with a ValidationException 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.
DeleteRequest or PutRequest). Each element in the map consists of the
following:
DeleteRequest - Perform a DeleteItem operation on the specified item. The item
to be deleted is identified by a Key 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 a PutItem operation on the specified item. The item to be
put is identified by an Item 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 will be rejected with a ValidationException 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.
public String returnConsumedCapacity()
ReturnConsumedCapacitypublic String 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 to NONE (the default), no statistics are returned.
SIZE, the response
includes statistics about item collections, if any, that were modified during the operation are returned
in the response. If set to NONE (the default), no statistics are returned.ReturnItemCollectionMetricspublic BatchWriteItemRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<BatchWriteItemRequest.Builder,BatchWriteItemRequest>public static BatchWriteItemRequest.Builder builder()
public static Class<? extends BatchWriteItemRequest.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.