com.amazonaws.services.dynamodbv2.model

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 and Description
BatchWriteItemRequest() Default constructor for BatchWriteItemRequest object.
BatchWriteItemRequest(Map<String,List<WriteRequest>> requestItems) Constructs a new BatchWriteItemRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
BatchWriteItemRequest	addRequestItemsEntry(String key, List<WriteRequest> value)
BatchWriteItemRequest	clearRequestItemsEntries() Removes all the entries added into RequestItems.
BatchWriteItemRequest	clone()
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() Returns the value of the ReturnConsumedCapacity property for this object.
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) Sets the value of the ReturnConsumedCapacity property for this object.
void	setReturnConsumedCapacity(String returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.
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) Sets the value of the ReturnConsumedCapacity property for this object.
BatchWriteItemRequest	withReturnConsumedCapacity(String returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.
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, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

• 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

Sets the value of the ReturnConsumedCapacity property for this object.

Parameters:

returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

Returns the value of the ReturnConsumedCapacity property for this object.

Returns:

The value of the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchWriteItemRequest withReturnConsumedCapacity(String 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

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Sets the value of the ReturnConsumedCapacity property for this object.

Parameters:

returnConsumedCapacity - The new value for the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchWriteItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity 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

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 to NONE (the default), no statistics are returned.

Parameters:

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.

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 to NONE (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 to NONE (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 to NONE (the default), no statistics are returned.

Parameters:

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.

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 to NONE (the default), no statistics are returned.

Parameters:

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.

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 to NONE (the default), no statistics are returned.

Parameters:

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.

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 class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchWriteItemRequest clone()

Overrides:

clone in class AmazonWebServiceRequest