public class PutItemRequest extends AmazonWebServiceRequest implements Serializable
PutItem operation.
Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add 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 exception.
You can request that PutItem return either a copy of the original item (before the update) or a copy of the updated item (after the update). For more information, see the ReturnValues description below.
NOTE: To prevent a new item from replacing an existing item, use a conditional put operation with ComparisonOperator set to NULL for the primary key attribute, or attributes.
For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide .
NOOP| Constructor and Description |
|---|
PutItemRequest()
Default constructor for a new 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.
|
| Modifier and Type | Method and Description |
|---|---|
PutItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value)
|
PutItemRequest |
addExpressionAttributeNamesEntry(String key,
String value)
One or more substitution tokens for attribute names in an expression.
|
PutItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
PutItemRequest |
addItemEntry(String key,
AttributeValue value)
A map of attribute name/value pairs, one for each attribute.
|
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.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
|
String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
PutItem operation to succeed.
|
Map<String,ExpectedAttributeValue> |
getExpected()
|
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()
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
String |
getReturnItemCollectionMetrics()
A value that if set to
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. |
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)
|
void |
setConditionalOperator(String conditionalOperator)
|
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)
|
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)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
A value that if set to
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. |
void |
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
A value that if set to
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. |
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; useful for testing and
debugging.
|
PutItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
|
PutItemRequest |
withConditionalOperator(String conditionalOperator)
|
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)
|
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)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
PutItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
PutItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
A value that if set to
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. |
PutItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
A value that if set to
SIZE, the response includes
statistics about item collections, if any, that were modified during
the operation are returned in the response. |
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.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic PutItemRequest()
public PutItemRequest(String tableName, Map<String,AttributeValue> item)
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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
public PutItemRequest(String tableName, Map<String,AttributeValue> item, String returnValues)
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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 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.
public PutItemRequest(String tableName, Map<String,AttributeValue> item, ReturnValue returnValues)
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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 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.
public String getTableName()
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
public void setTableName(String tableName)
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table to contain the item.public PutItemRequest withTableName(String tableName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
tableName - The name of the table to contain the item.public Map<String,AttributeValue> getItem()
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
public void setItem(Map<String,AttributeValue> item)
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
public PutItemRequest withItem(Map<String,AttributeValue> item)
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in 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.
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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
public PutItemRequest addItemEntry(String key, AttributeValue value)
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.
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 in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
The method adds a new key-value pair into Item parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into Item.value - The corresponding value of the entry to be added into Item.public PutItemRequest clearItemEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,ExpectedAttributeValue> getExpected()
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
public void setExpected(Map<String,ExpectedAttributeValue> expected)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
expected - There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
public PutItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
Returns a reference to this object so that method calls can be chained together.
expected - There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
public PutItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one provided in the
request, the value does not match. For example, {"S":"6"}
does not equal {"N":"6"}. Also, {"N":"6"}
does not equal {"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
provided in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one provided in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, 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 condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
The method adds a new key-value pair into Expected parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into Expected.value - The corresponding value of the entry to be added into Expected.public PutItemRequest clearExpectedEntries()
Returns a reference to this object so that method calls can be chained together.
public String getReturnValues()
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.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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.
ReturnValuepublic void setReturnValues(String returnValues)
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.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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.
ReturnValuepublic PutItemRequest withReturnValues(String returnValues)
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.
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
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.
ReturnValuepublic void setReturnValues(ReturnValue returnValues)
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.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
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.
ReturnValuepublic PutItemRequest withReturnValues(ReturnValue returnValues)
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.
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
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.
ReturnValuepublic String getReturnConsumedCapacity()
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic PutItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic PutItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
returnConsumedCapacity - A value that if set to TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.ReturnConsumedCapacitypublic String getReturnItemCollectionMetrics()
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.
Constraints:
Allowed Values: SIZE, NONE
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.ReturnItemCollectionMetricspublic void setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics - A value that 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.ReturnItemCollectionMetricspublic PutItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics - A value that 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.ReturnItemCollectionMetricspublic void setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics - A value that 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.ReturnItemCollectionMetricspublic PutItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
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 a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SIZE, NONE
returnItemCollectionMetrics - A value that 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.ReturnItemCollectionMetricspublic String getConditionalOperator()
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
ConditionalOperatorpublic void setConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
ConditionalOperatorpublic PutItemRequest withConditionalOperator(String conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
ConditionalOperatorpublic PutItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
ConditionalOperatorpublic String getConditionExpression()
An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setConditionExpression(String conditionExpression)
An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
conditionExpression - A condition that must be satisfied in order for a conditional
PutItem operation to succeed. An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public PutItemRequest withConditionExpression(String conditionExpression)
An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
conditionExpression - A condition that must be satisfied in order for a conditional
PutItem operation to succeed. An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public Map<String,String> getExpressionAttributeNames()
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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeNames(Map<String,String> 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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public PutItemRequest withExpressionAttributeNames(Map<String,String> 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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public PutItemRequest addExpressionAttributeNamesEntry(String key, String value)
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, go to 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, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into ExpressionAttributeNames parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into ExpressionAttributeNames.value - The corresponding value of the entry to be added into ExpressionAttributeNames.public PutItemRequest clearExpressionAttributeNamesEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,AttributeValue> getExpressionAttributeValues()
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public void setExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public PutItemRequest withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
public PutItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
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, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
The method adds a new key-value pair into ExpressionAttributeValues parameter, and returns a reference to this object so that method calls can be chained together.
key - The key of the entry to be added into ExpressionAttributeValues.value - The corresponding value of the entry to be added into ExpressionAttributeValues.public PutItemRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString in class ObjectObject.toString()Copyright © 2015. All rights reserved.