PutItemRequest (AWS Java SDK for Amazon DynamoDB 1.12.19 API)

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutItemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input of a PutItem operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`PutItemRequest()` Default constructor for PutItemRequest object.
`PutItemRequest(String tableName, Map<String,AttributeValue> item)` Constructs a new PutItemRequest object.
`PutItemRequest(String tableName, Map<String,AttributeValue> item, ReturnValue returnValues)` Constructs a new PutItemRequest object.
`PutItemRequest(String tableName, Map<String,AttributeValue> item, String returnValues)` Constructs a new PutItemRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PutItemRequest`	`addExpectedEntry(String key, ExpectedAttributeValue value)` Add a single Expected entry
`PutItemRequest`	`addExpressionAttributeNamesEntry(String key, String value)` Add a single ExpressionAttributeNames entry
`PutItemRequest`	`addExpressionAttributeValuesEntry(String key, AttributeValue value)` Add a single ExpressionAttributeValues entry
`PutItemRequest`	`addItemEntry(String key, AttributeValue value)` Add a single Item entry
`PutItemRequest`	`clearExpectedEntries()` Removes all the entries added into Expected.
`PutItemRequest`	`clearExpressionAttributeNamesEntries()` Removes all the entries added into ExpressionAttributeNames.
`PutItemRequest`	`clearExpressionAttributeValuesEntries()` Removes all the entries added into ExpressionAttributeValues.
`PutItemRequest`	`clearItemEntries()` Removes all the entries added into Item.
`PutItemRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getConditionalOperator()` This is a legacy parameter.
`String`	`getConditionExpression()` A condition that must be satisfied in order for a conditional `PutItem` operation to succeed.
`Map<String,ExpectedAttributeValue>`	`getExpected()` This is a legacy parameter.
`Map<String,String>`	`getExpressionAttributeNames()` One or more substitution tokens for attribute names in an expression.
`Map<String,AttributeValue>`	`getExpressionAttributeValues()` One or more values that can be substituted in an expression.
`Map<String,AttributeValue>`	`getItem()` A map of attribute name/value pairs, one for each attribute.
`String`	`getReturnConsumedCapacity()`
`String`	`getReturnItemCollectionMetrics()` Determines whether item collection metrics are returned.
`String`	`getReturnValues()` Use `ReturnValues` if you want to get the item attributes as they appeared before they were updated with the `PutItem` request.
`String`	`getTableName()` The name of the table to contain the item.
`int`	`hashCode()`
`void`	`setConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`void`	`setConditionalOperator(String conditionalOperator)` This is a legacy parameter.
`void`	`setConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional `PutItem` operation to succeed.
`void`	`setExpected(Map<String,ExpectedAttributeValue> expected)` This is a legacy parameter.
`void`	`setExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`void`	`setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`void`	`setItem(Map<String,AttributeValue> item)` A map of attribute name/value pairs, one for each attribute.
`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.
`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(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(String tableName)` The name of the table to contain the item.
`String`	`toString()` Returns a string representation of this object.
`PutItemRequest`	`withConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`PutItemRequest`	`withConditionalOperator(String conditionalOperator)` This is a legacy parameter.
`PutItemRequest`	`withConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional `PutItem` operation to succeed.
`PutItemRequest`	`withExpected(Map<String,ExpectedAttributeValue> expected)` This is a legacy parameter.
`PutItemRequest`	`withExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`PutItemRequest`	`withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`PutItemRequest`	`withItem(Map<String,AttributeValue> item)` A map of attribute name/value pairs, one for each attribute.
`PutItemRequest`	`withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)`
`PutItemRequest`	`withReturnConsumedCapacity(String returnConsumedCapacity)`
`PutItemRequest`	`withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`PutItemRequest`	`withReturnItemCollectionMetrics(String returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`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(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(String tableName)` The name of the table to contain the item.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutItemRequest
```
public PutItemRequest()
```
    Default constructor for PutItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - PutItemRequest
```
public PutItemRequest(String tableName,
                      Map<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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
  - PutItemRequest
```
public PutItemRequest(String tableName,
                      Map<String,AttributeValue> item,
                      String returnValues)
```
    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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
  - PutItemRequest
```
public PutItemRequest(String tableName,
                      Map<String,AttributeValue> item,
                      ReturnValue returnValues)
```
    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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
- Method Detail
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table to contain the item.
    
    Parameters:
    
    tableName - The name of the table to contain the item.
  - getTableName
```
public String getTableName()
```
    The name of the table to contain the item.
    
    Returns:
    
    The name of the table to contain the item.
  - withTableName
```
public PutItemRequest withTableName(String tableName)
```
    The name of the table to contain the item.
    
    Parameters:
    
    tableName - The name of the table to contain the item.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getItem
```
public Map<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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in 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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
  - setItem
```
public void setItem(Map<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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in 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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
  - withItem
```
public PutItemRequest withItem(Map<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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in 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.
    
    You must provide all of the attributes for the primary key. 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 both values for both the partition key and the sort key.
    
    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.
    
    Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.
    
    For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    
    Each element in the Item map is an AttributeValue object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addItemEntry
```
public PutItemRequest addItemEntry(String key,
                                   AttributeValue value)
```
    Add a single Item entry
    
    See Also:
    
    withItem(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.AttributeValue>)
  - clearItemEntries
```
public PutItemRequest clearItemEntries()
```
    Removes all the entries added into Item.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpected
```
public Map<String,ExpectedAttributeValue> getExpected()
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
  - setExpected
```
public void setExpected(Map<String,ExpectedAttributeValue> expected)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
  - withExpected
```
public PutItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expected - This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpectedEntry
```
public PutItemRequest addExpectedEntry(String key,
                                       ExpectedAttributeValue value)
```
    Add a single Expected entry
    
    See Also:
    
    withExpected(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue>)
  - clearExpectedEntries
```
public PutItemRequest clearExpectedEntries()
```
    Removes all the entries added into Expected.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReturnValues
```
public void setReturnValues(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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    See Also:
    
    ReturnValue
  - getReturnValues
```
public 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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    See Also:
    
    ReturnValue
  - withReturnValues
```
public PutItemRequest withReturnValues(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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    Returns:
    
    Returns a reference to this 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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    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 - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.
    
    The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnValue
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(String returnConsumedCapacity)
```
    Parameters:
    
    returnConsumedCapacity -
    
    See Also:
    
    ReturnConsumedCapacity
  - getReturnConsumedCapacity
```
public String getReturnConsumedCapacity()
```
    Returns:
    
    See Also:
    
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public PutItemRequest 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 PutItemRequest 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 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 PutItemRequest 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 PutItemRequest 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
  - setConditionalOperator
```
public void setConditionalOperator(String conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - getConditionalOperator
```
public String getConditionalOperator()
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public PutItemRequest withConditionalOperator(String conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - setConditionalOperator
```
public void setConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - setConditionExpression
```
public void setConditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    - Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
      
      These function names are case-sensitive.
    - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    - Logical operators: AND | OR | NOT
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    Parameters:
    conditionExpression - A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    
    Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
    
    These function names are case-sensitive.
    
    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    
    Logical operators: AND | OR | NOT
    
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
  - getConditionExpression
```
public String getConditionExpression()
```
    A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    - Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
      
      These function names are case-sensitive.
    - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    - Logical operators: AND | OR | NOT
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    Returns:
    A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    
    Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
    
    These function names are case-sensitive.
    
    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    
    Logical operators: AND | OR | NOT
    
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
  - withConditionExpression
```
public PutItemRequest withConditionExpression(String conditionExpression)
```
    A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    - Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
      
      These function names are case-sensitive.
    - Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    - Logical operators: AND | OR | NOT
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    Parameters:
    conditionExpression - A condition that must be satisfied in order for a conditional PutItem operation to succeed.
    
    An expression can contain any of the following:
    
    Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
    
    These function names are case-sensitive.
    
    Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
    
    Logical operators: AND | OR | NOT
    
    For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeNames
```
public Map<String,String> getExpressionAttributeNames()
```
    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    - To access an attribute whose name conflicts with a DynamoDB reserved word.
    - To create a placeholder for repeating occurrences of an attribute name in an expression.
    - To prevent special characters in an attribute name from being misinterpreted in an expression.
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    - Percentile
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    - {"#P":"Percentile"}
    You could then use this substitution in an expression, as in this example:
    - #P = :val
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Returns:
    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    
    To access an attribute whose name conflicts with a DynamoDB reserved word.
    
    To create a placeholder for repeating occurrences of an attribute name in an expression.
    
    To prevent special characters in an attribute name from being misinterpreted in an expression.
    
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    
    Percentile
    
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    
    {"#P":"Percentile"}
    
    You could then use this substitution in an expression, as in this example:
    
    #P = :val
    
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
  - setExpressionAttributeNames
```
public void setExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    - To access an attribute whose name conflicts with a DynamoDB reserved word.
    - To create a placeholder for repeating occurrences of an attribute name in an expression.
    - To prevent special characters in an attribute name from being misinterpreted in an expression.
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    - Percentile
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    - {"#P":"Percentile"}
    You could then use this substitution in an expression, as in this example:
    - #P = :val
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Parameters:
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    
    To access an attribute whose name conflicts with a DynamoDB reserved word.
    
    To create a placeholder for repeating occurrences of an attribute name in an expression.
    
    To prevent special characters in an attribute name from being misinterpreted in an expression.
    
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    
    Percentile
    
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    
    {"#P":"Percentile"}
    
    You could then use this substitution in an expression, as in this example:
    
    #P = :val
    
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
  - withExpressionAttributeNames
```
public PutItemRequest withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
```
    One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    - To access an attribute whose name conflicts with a DynamoDB reserved word.
    - To create a placeholder for repeating occurrences of an attribute name in an expression.
    - To prevent special characters in an attribute name from being misinterpreted in an expression.
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    - Percentile
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    - {"#P":"Percentile"}
    You could then use this substitution in an expression, as in this example:
    - #P = :val
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Parameters:
    expressionAttributeNames - One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:
    
    To access an attribute whose name conflicts with a DynamoDB reserved word.
    
    To create a placeholder for repeating occurrences of an attribute name in an expression.
    
    To prevent special characters in an attribute name from being misinterpreted in an expression.
    
    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
    
    Percentile
    
    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
    
    {"#P":"Percentile"}
    
    You could then use this substitution in an expression, as in this example:
    
    #P = :val
    
    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
    
    For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpressionAttributeNamesEntry
```
public PutItemRequest addExpressionAttributeNamesEntry(String key,
                                                       String value)
```
    Add a single ExpressionAttributeNames entry
    
    See Also:
    
    withExpressionAttributeNames(java.util.Map<java.lang.String, java.lang.String>)
  - clearExpressionAttributeNamesEntries
```
public PutItemRequest clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeValues
```
public Map<String,AttributeValue> getExpressionAttributeValues()
```
    One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
  - setExpressionAttributeValues
```
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
  - withExpressionAttributeValues
```
public PutItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
```
    One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expressionAttributeValues - One or more values that can be substituted in an expression.
    
    Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
    
    Available | Backordered | Discontinued
    
    You would first need to specify ExpressionAttributeValues as follows:
    
    { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
    
    You could then use these values in an expression, such as this:
    
    ProductStatus IN (:avail, :back, :disc)
    
    For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpressionAttributeValuesEntry
```
public PutItemRequest addExpressionAttributeValuesEntry(String key,
                                                        AttributeValue value)
```
    Add a single ExpressionAttributeValues entry
    
    See Also:
    
    withExpressionAttributeValues(java.util.Map<java.lang.String, com.amazonaws.services.dynamodbv2.model.AttributeValue>)
  - clearExpressionAttributeValuesEntries
```
public PutItemRequest clearExpressionAttributeValuesEntries()
```
    Removes all the entries added into ExpressionAttributeValues.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 PutItemRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class PutItemRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutItemRequest

PutItemRequest

PutItemRequest

PutItemRequest

Method Detail

setTableName

getTableName

withTableName

getItem

setItem

withItem

addItemEntry

clearItemEntries

getExpected

setExpected

withExpected

addExpectedEntry

clearExpectedEntries

setReturnValues

getReturnValues

withReturnValues

setReturnValues

withReturnValues

setReturnConsumedCapacity

getReturnConsumedCapacity

withReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

setReturnItemCollectionMetrics

getReturnItemCollectionMetrics

withReturnItemCollectionMetrics

setReturnItemCollectionMetrics

withReturnItemCollectionMetrics

setConditionalOperator

getConditionalOperator

withConditionalOperator

setConditionalOperator

withConditionalOperator

setConditionExpression

getConditionExpression

withConditionExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

getExpressionAttributeValues

setExpressionAttributeValues

withExpressionAttributeValues

addExpressionAttributeValuesEntry

clearExpressionAttributeValuesEntries

toString

equals

hashCode

clone