Class BatchWriteItemRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of a BatchWriteItem operation.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description BatchWriteItemRequest()
Default constructor for BatchWriteItemRequest object.BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems)
Constructs a new BatchWriteItemRequest object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchWriteItemRequest
addRequestItemsEntry(String key, List<WriteRequest> value)
BatchWriteItemRequest
clearRequestItemsEntries()
Removes all the entries added into RequestItems.BatchWriteItemRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Map<String,List<WriteRequest>>
getRequestItems()
A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest).String
getReturnConsumedCapacity()
String
getReturnItemCollectionMetrics()
Determines whether item collection metrics are returned.int
hashCode()
void
setRequestItems(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).void
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
void
setReturnConsumedCapacity(String returnConsumedCapacity)
void
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.void
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.String
toString()
Returns a string representation of this object; useful for testing and debugging.BatchWriteItemRequest
withRequestItems(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).BatchWriteItemRequest
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
BatchWriteItemRequest
withReturnConsumedCapacity(String returnConsumedCapacity)
BatchWriteItemRequest
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Determines whether item collection metrics are returned.BatchWriteItemRequest
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
Determines whether item collection metrics are returned.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
BatchWriteItemRequest
public BatchWriteItemRequest()
Default constructor for BatchWriteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
BatchWriteItemRequest
public BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems)
Constructs a new BatchWriteItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
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.
-
-
-
-
Method Detail
-
getRequestItems
public Map<String,List<WriteRequest>> getRequestItems()
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.
-
- Returns:
- 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.
-
-
-
-
setRequestItems
public void setRequestItems(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.
-
- Parameters:
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.
-
-
-
-
withRequestItems
public BatchWriteItemRequest withRequestItems(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.
-
- Parameters:
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.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addRequestItemsEntry
public BatchWriteItemRequest addRequestItemsEntry(String key, List<WriteRequest> value)
-
clearRequestItemsEntries
public BatchWriteItemRequest clearRequestItemsEntries()
Removes all the entries added into RequestItems. <p> Returns a reference to this object so that method calls can be chained together.
-
setReturnConsumedCapacity
public void setReturnConsumedCapacity(String returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- See Also:
ReturnConsumedCapacity
-
getReturnConsumedCapacity
public String getReturnConsumedCapacity()
- Returns:
- See Also:
ReturnConsumedCapacity
-
withReturnConsumedCapacity
public BatchWriteItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReturnConsumedCapacity
-
setReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- See Also:
ReturnConsumedCapacity
-
withReturnConsumedCapacity
public BatchWriteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ReturnConsumedCapacity
-
setReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(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 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.- See Also:
ReturnItemCollectionMetrics
-
getReturnItemCollectionMetrics
public String getReturnItemCollectionMetrics()
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.- Returns:
- 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. - See Also:
ReturnItemCollectionMetrics
-
withReturnItemCollectionMetrics
public BatchWriteItemRequest withReturnItemCollectionMetrics(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 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
-
setReturnItemCollectionMetrics
public void setReturnItemCollectionMetrics(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.- See Also:
ReturnItemCollectionMetrics
-
withReturnItemCollectionMetrics
public BatchWriteItemRequest withReturnItemCollectionMetrics(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:
ReturnItemCollectionMetrics
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public BatchWriteItemRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-