public class DeleteItemRequest extends AmazonWebServiceRequest implements Serializable
DeleteItem operation.
Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.
In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.
Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.
Conditional deletes are useful for only deleting items if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
NOOP| Constructor and Description |
|---|
DeleteItemRequest()
Default constructor for a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
ReturnValue returnValues)
Constructs a new DeleteItemRequest object.
|
DeleteItemRequest(String tableName,
Map<String,AttributeValue> key,
String returnValues)
Constructs a new DeleteItemRequest object.
|
| Modifier and Type | Method and Description |
|---|---|
DeleteItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value)
A map of attribute/condition pairs.
|
DeleteItemRequest |
addKeyEntry(String key,
AttributeValue value)
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
DeleteItemRequest |
clearExpectedEntries()
Removes all the entries added into Expected.
|
DeleteItemRequest |
clearKeyEntries()
Removes all the entries added into Key.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
A logical operator to apply to the conditions in the Expected
map:
|
Map<String,ExpectedAttributeValue> |
getExpected()
A map of attribute/condition pairs.
|
Map<String,AttributeValue> |
getKey()
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
String |
getReturnConsumedCapacity()
If set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
String |
getReturnItemCollectionMetrics()
If set to
SIZE, 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 deleted.
|
String |
getTableName()
The name of the table from which to delete the item.
|
int |
hashCode() |
void |
setConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected
map:
|
void |
setConditionalOperator(String conditionalOperator)
A logical operator to apply to the conditions in the Expected
map:
|
void |
setExpected(Map<String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs.
|
void |
setKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
void |
setKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
void |
setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnConsumedCapacity(String returnConsumedCapacity)
If set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
void |
setReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
If set to
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. |
void |
setReturnItemCollectionMetrics(String returnItemCollectionMetrics)
If set to
SIZE, 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 deleted.
|
void |
setReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
void |
setTableName(String tableName)
The name of the table from which to delete the item.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DeleteItemRequest |
withConditionalOperator(ConditionalOperator conditionalOperator)
A logical operator to apply to the conditions in the Expected
map:
|
DeleteItemRequest |
withConditionalOperator(String conditionalOperator)
A logical operator to apply to the conditions in the Expected
map:
|
DeleteItemRequest |
withExpected(Map<String,ExpectedAttributeValue> expected)
A map of attribute/condition pairs.
|
DeleteItemRequest |
withKey(Map.Entry<String,AttributeValue> hashKey,
Map.Entry<String,AttributeValue> rangeKey)
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
DeleteItemRequest |
withKey(Map<String,AttributeValue> key)
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
DeleteItemRequest |
withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
If set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
DeleteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
If set to
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. |
DeleteItemRequest |
withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
If set to
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. |
DeleteItemRequest |
withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
If set to
SIZE, statistics about item collections, if
any, that were modified during the operation are returned in the
response. |
DeleteItemRequest |
withReturnValues(ReturnValue returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
DeleteItemRequest |
withReturnValues(String returnValues)
Use ReturnValues if you want to get the item attributes as they
appeared before they were deleted.
|
DeleteItemRequest |
withTableName(String tableName)
The name of the table from which to delete the item.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic DeleteItemRequest()
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, String returnValues)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.returnValues - Use ReturnValues if you want to get the
item attributes as they appeared before they were deleted. For
DeleteItem, the valid values are: NONE - If ReturnValues is not specified, or if
its value is NONE, then nothing is returned. (This is the
default for ReturnValues.)
ALL_OLD -
The content of the old item is returned.
public DeleteItemRequest(String tableName, Map<String,AttributeValue> key, ReturnValue returnValues)
tableName - The name of the table from which to delete the item.key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.returnValues - Use ReturnValues if you want to get the
item attributes as they appeared before they were deleted. For
DeleteItem, the valid values are: NONE - If ReturnValues is not specified, or if
its value is NONE, then nothing is returned. (This is the
default for ReturnValues.)
ALL_OLD -
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 from which to delete the item.public DeleteItemRequest 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 from which to delete the item.public Map<String,AttributeValue> getKey()
public void setKey(Map<String,AttributeValue> key)
key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.public DeleteItemRequest withKey(Map<String,AttributeValue> key)
Returns a reference to this object so that method calls can be chained together.
key - A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.public void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
This method accepts the hashKey, rangeKey of Key as
java.util.Map.Entry
hashKey - Primary hash key.rangeKey - Primary range key. (null if it a hash-only table)IllegalArgumentExceptionpublic DeleteItemRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
This method accepts the hashKey, rangeKey of Key as
java.util.Map.Entry
Returns a reference to this object so that method calls can be chained together.
hashKey - Primary hash key.rangeKey - Primary range key. (null if it a hash-only table)IllegalArgumentExceptionpublic DeleteItemRequest addKeyEntry(String key, AttributeValue value)
The method adds a new key-value pair into Key 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 Key.value - The corresponding value of the entry to be added into Key.public DeleteItemRequest clearKeyEntries()
Returns a reference to this object so that method calls can be chained together.
public Map<String,ExpectedAttributeValue> getExpected()
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
public void setExpected(Map<String,ExpectedAttributeValue> expected)
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
expected - A map of attribute/condition pairs. This is the conditional block for
the DeleteItem operation. 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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
public DeleteItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
Returns a reference to this object so that method calls can be chained together.
expected - A map of attribute/condition pairs. This is the conditional block for
the DeleteItem operation. 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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
public DeleteItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
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.
Each item in Expected represents an attribute name for DynamoDB to check, along with an AttributeValueList and a ComparisonOperator:
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 aa is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
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.
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 specified 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.
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 specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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 of type String, Number, or Binary (not a set).
If an item contains an AttributeValue of a different type than
the one specified 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"]}.
NOT_NULL : The
attribute exists.
NULL : The attribute does
not exist.
CONTAINS : checks for a
subsequence, or value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for a member of the set (not as a substring).
NOT_CONTAINS : checks for absence of a
subsequence, or absence of a value in a set.
AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation 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 operation checks for the absence of a member of the set (not as a substring).
BEGINS_WITH : checks for a
prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
IN :
checks for exact matches.
AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
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). 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 of a different
type than the one specified 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 Conditional
Expressions 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 -
Causes DynamoDB to evaluate the value vefore attempting the
conditional operation: If Exists is
If Exists is Even though DynamoDB continues to
accept the Value and Exists parameters, they are now
deprecated. We recommend that you use AttributeValueList and
ComparisonOperator instead, since they allow you to constuct a
much wider range of conditions. The Value and Exists
parameters are incompatible with AttributeValueList and
ComparisonOperator. If you attempt to use both sets of
parameters at once, DynamoDB will throw a ValidationException.
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.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.???
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 DeleteItemRequest clearExpectedEntries()
Returns a reference to this object so that method calls can be chained together.
public String getConditionalOperator()
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.
Constraints:
Allowed Values: AND, OR
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.
ConditionalOperatorpublic void setConditionalOperator(String conditionalOperator)
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.
Constraints:
Allowed Values: AND, OR
conditionalOperator - 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.
ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(String conditionalOperator)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - 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.
ConditionalOperatorpublic void setConditionalOperator(ConditionalOperator conditionalOperator)
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.
Constraints:
Allowed Values: AND, OR
conditionalOperator - 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.
ConditionalOperatorpublic DeleteItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: AND, OR
conditionalOperator - 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.
ConditionalOperatorpublic String getReturnValues()
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - 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 is the default for ReturnValues.)
ALL_OLD - 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 is the default for ReturnValues.)
ALL_OLD - 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 deleted. For DeleteItem, the valid
values are: NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
ReturnValuepublic DeleteItemRequest withReturnValues(String returnValues)
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - 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 deleted. For DeleteItem, the valid
values are: NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - 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 is the default for ReturnValues.)
ALL_OLD - 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 deleted. For DeleteItem, the valid
values are: NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.
ReturnValuepublic DeleteItemRequest withReturnValues(ReturnValue returnValues)
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - 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 deleted. For DeleteItem, the valid
values are: NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This is the default for ReturnValues.)
ALL_OLD - 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 - 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 DeleteItemRequest 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 - 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 - 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 DeleteItemRequest 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 - 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, 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, 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, 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 - If set to SIZE, 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 DeleteItemRequest withReturnItemCollectionMetrics(String returnItemCollectionMetrics)
SIZE, 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 - If set to SIZE, 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, 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 - If set to SIZE, 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 DeleteItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
SIZE, 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 - If set to SIZE, 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 toString()
toString in class ObjectObject.toString()Copyright © 2014. All rights reserved.