com.amazonaws.services.dynamodbv2.model
Class PutItemRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.dynamodbv2.model.PutItemRequest

All Implemented Interfaces:

java.io.Serializable

public class PutItemRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the PutItem operation.

Creates a new item, or replaces an old item with a new item. If an item already exists in the specified table with the same primary key, the new item completely replaces the existing item. You can perform a conditional put (insert a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException .

You can request that PutItem return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the ReturnValues description.

NOTE: To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes.

For more information about using this API, see Working with Items of the Amazon DynamoDB Developer Guide .

See Also:

AmazonDynamoDB.putItem(PutItemRequest), Serialized Form

Constructor Summary

PutItemRequest()
Default constructor for a new PutItemRequest object.

PutItemRequest(java.lang.String tableName, java.util.Map<java.lang.String,AttributeValue> item)
Constructs a new PutItemRequest object.

Method Summary

boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,ExpectedAttributeValue>	getExpected() A map of attribute/condition pairs.
java.util.Map<java.lang.String,AttributeValue>	getItem() A map of attribute name/value pairs, one for each attribute.
java.lang.String	getReturnConsumedCapacity() Determines whether to include consumed capacity information in the output.
java.lang.String	getReturnItemCollectionMetrics() Indicates whether to return statistics about item collections, if any, that were modified during the operation.
java.lang.String	getReturnValues() Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
java.lang.String	getTableName() The name of the table to contain the item.
int	hashCode()
void	setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected) A map of attribute/condition pairs.
void	setItem(java.util.Map<java.lang.String,AttributeValue> item) A map of attribute name/value pairs, one for each attribute.
void	setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) Determines whether to include consumed capacity information in the output.
void	setReturnConsumedCapacity(java.lang.String returnConsumedCapacity) Determines whether to include consumed capacity information in the output.
void	setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Indicates whether to return statistics about item collections, if any, that were modified during the operation.
void	setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics) Indicates whether to return statistics about item collections, if any, that were modified during the operation.
void	setReturnValues(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
void	setReturnValues(java.lang.String returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
void	setTableName(java.lang.String tableName) The name of the table to contain the item.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
PutItemRequest	withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected) A map of attribute/condition pairs.
PutItemRequest	withItem(java.util.Map<java.lang.String,AttributeValue> item) A map of attribute name/value pairs, one for each attribute.
PutItemRequest	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity) Determines whether to include consumed capacity information in the output.
PutItemRequest	withReturnConsumedCapacity(java.lang.String returnConsumedCapacity) Determines whether to include consumed capacity information in the output.
PutItemRequest	withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Indicates whether to return statistics about item collections, if any, that were modified during the operation.
PutItemRequest	withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics) Indicates whether to return statistics about item collections, if any, that were modified during the operation.
PutItemRequest	withReturnValues(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
PutItemRequest	withReturnValues(java.lang.String returnValues) Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.
PutItemRequest	withTableName(java.lang.String tableName) The name of the table to contain the item.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutItemRequest

public PutItemRequest()

Default constructor for a new PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PutItemRequest

public PutItemRequest(java.lang.String tableName,
                      java.util.Map<java.lang.String,AttributeValue> item)

Constructs a new PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

tableName - The name of the table to contain the item.

item - A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Method Detail

getTableName

public java.lang.String getTableName()

The name of the table to contain the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the table to contain the item.

setTableName

public void setTableName(java.lang.String tableName)

The name of the table to contain the item.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table to contain the item.

withTableName

public PutItemRequest withTableName(java.lang.String tableName)

The name of the table to contain the item.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName - The name of the table to contain the item.

Returns:

A reference to this updated object so that method calls can be chained together.

getItem

public java.util.Map<java.lang.String,AttributeValue> getItem()

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Returns:

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

setItem

public void setItem(java.util.Map<java.lang.String,AttributeValue> item)

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Parameters:

item - A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

withItem

public PutItemRequest withItem(java.util.Map<java.lang.String,AttributeValue> item)

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Returns a reference to this object so that method calls can be chained together.

Parameters:

item - A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

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.

For more information about primary keys, see Primary Key of the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Returns:

A reference to this updated object so that method calls can be chained together.

getExpected

public java.util.Map<java.lang.String,ExpectedAttributeValue> getExpected()

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Returns:

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

setExpected

public void setExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Parameters:

expected - A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

withExpected

public PutItemRequest withExpected(java.util.Map<java.lang.String,ExpectedAttributeValue> expected)

A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Returns a reference to this object so that method calls can be chained together.

Parameters:

expected - A map of attribute/condition pairs. This is the conditional block for the PutItem operation. All the conditions must be met for the operation to succeed.

Expected allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it.

Each item in Expected represents an attribute name for Amazon DynamoDB to check, along with the following:

• Value-the attribute value for Amazon DynamoDB to check.

• Exists-causes Amazon DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, Amazon DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, Amazon DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

  The default setting for Exists is true. If you supply a Value all by itself, Amazon DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

  Amazon DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

If you specify more than one condition for Exists, then all of the conditions must evaluate to true. (In other words, the conditions are ANDed together.) Otherwise, the conditional operation will fail.

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnValues

public java.lang.String getReturnValues()

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Returns:

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

See Also:

ReturnValue

setReturnValues

public void setReturnValues(java.lang.String returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

See Also:

ReturnValue

withReturnValues

public PutItemRequest withReturnValues(java.lang.String returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnValue

setReturnValues

public void setReturnValues(ReturnValue returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

See Also:

ReturnValue

withReturnValues

public PutItemRequest withReturnValues(ReturnValue returnValues)

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

Parameters:

returnValues - Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

• NONE-(default) If ReturnValues is not specified, or if its value is NONE, then nothing is returned.

• ALL_OLD-If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnValue

getReturnConsumedCapacity

public java.lang.String getReturnConsumedCapacity()

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Constraints:
Allowed Values: TOTAL, NONE

Returns:

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(java.lang.String returnConsumedCapacity)

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Constraints:
Allowed Values: TOTAL, NONE

Parameters:

returnConsumedCapacity - Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public PutItemRequest withReturnConsumedCapacity(java.lang.String returnConsumedCapacity)

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TOTAL, NONE

Parameters:

returnConsumedCapacity - Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Constraints:
Allowed Values: TOTAL, NONE

Parameters:

returnConsumedCapacity - Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public PutItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: TOTAL, NONE

Parameters:

returnConsumedCapacity - Determines whether to include consumed capacity information in the output. If this is set to TOTAL, then this information is shown in the output; otherwise, the consumed capacity information is not shown.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

getReturnItemCollectionMetrics

public java.lang.String getReturnItemCollectionMetrics()

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Constraints:
Allowed Values: SIZE, NONE

Returns:

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

See Also:

ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public PutItemRequest withReturnItemCollectionMetrics(java.lang.String returnItemCollectionMetrics)

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnItemCollectionMetrics

setReturnItemCollectionMetrics

public void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

See Also:

ReturnItemCollectionMetrics

withReturnItemCollectionMetrics

public PutItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)

Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: SIZE, NONE

Parameters:

returnItemCollectionMetrics - Indicates whether to return statistics about item collections, if any, that were modified during the operation. The default for ReturnItemCollectionMetrics is NONE, meaning that no statistics will be returned. To obtain the statistics, set ReturnItemCollectionMetrics to SIZE.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ReturnItemCollectionMetrics

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object