com.amazonaws.services.dynamodb.model
Class PutItemRequest

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

public class PutItemRequest
extends AmazonWebServiceRequest

Container for the parameters to the PutItem operation.

Creates a new item, or replaces an old item with a new item (including all the attributes).

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.

See Also:

AmazonDynamoDB.putItem(PutItemRequest)

Constructor Summary

PutItemRequest()
Default constructor for a new PutItemRequest object.

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

Method Summary

boolean	equals(Object obj)
Map<String,ExpectedAttributeValue>	getExpected() Designates an attribute for a conditional modification.
Map<String,AttributeValue>	getItem() A map of the attributes for the item, and must include the primary key values that define the item.
String	getReturnValues() Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
String	getTableName() The name of the table in which you want to put an item.
int	hashCode()
void	setExpected(Map<String,ExpectedAttributeValue> expected) Designates an attribute for a conditional modification.
void	setItem(Map<String,AttributeValue> item) A map of the attributes for the item, and must include the primary key values that define the item.
void	setReturnValues(ReturnValue returnValues) Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
void	setReturnValues(String returnValues) Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
void	setTableName(String tableName) The name of the table in which you want to put an item.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutItemRequest	withExpected(Map<String,ExpectedAttributeValue> expected) Designates an attribute for a conditional modification.
PutItemRequest	withItem(Map<String,AttributeValue> item) A map of the attributes for the item, and must include the primary key values that define the item.
PutItemRequest	withReturnValues(ReturnValue returnValues) Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
PutItemRequest	withReturnValues(String returnValues) Use this parameter if you want to get the attribute name-value pairs before or after they are modified.
PutItemRequest	withTableName(String tableName) The name of the table in which you want to put an item.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, 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(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 in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

item - A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Method Detail

getTableName

public String getTableName()

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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

Returns:

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

setTableName

public void setTableName(String tableName)

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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

Parameters:

tableName - The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

withTableName

public PutItemRequest withTableName(String tableName)

The name of the table in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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 in which you want to put an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

Returns:

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

getItem

public Map<String,AttributeValue> getItem()

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Returns:

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

setItem

public void setItem(Map<String,AttributeValue> item)

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Parameters:

item - A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

withItem

public PutItemRequest withItem(Map<String,AttributeValue> item)

A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

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

Parameters:

item - A map of the attributes for the item, and must include the primary key values that define the item. Other attribute name-value pairs can be provided for the item.

Returns:

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

getExpected

public Map<String,ExpectedAttributeValue> getExpected()

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

Returns:

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

setExpected

public void setExpected(Map<String,ExpectedAttributeValue> expected)

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

Parameters:

expected - Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

withExpected

public PutItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)

Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

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

Parameters:

expected - Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.

Returns:

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

getReturnValues

public String getReturnValues()

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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

Returns:

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

See Also:

ReturnValue

setReturnValues

public void setReturnValues(String returnValues)

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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

Parameters:

returnValues - Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

See Also:

ReturnValue

withReturnValues

public PutItemRequest withReturnValues(String returnValues)

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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 this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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 this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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

Parameters:

returnValues - Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

See Also:

ReturnValue

withReturnValues

public PutItemRequest withReturnValues(ReturnValue returnValues)

Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

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 this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

• NONE: Nothing is returned.
• ALL_OLD: Returns the attributes of the item as they were before the operation.
• UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
• ALL_NEW: Returns all the attributes and their new values after the operation.
• UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Returns:

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

See Also:

ReturnValue

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object