public class DeleteItemRequest extends com.amazonaws.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 deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.
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)
|
DeleteItemRequest |
addExpressionAttributeNamesEntry(String key,
String value)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
One or more values that can be substituted in an expression.
|
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 |
clearExpressionAttributeNamesEntries()
Removes all the entries added into ExpressionAttributeNames.
|
DeleteItemRequest |
clearExpressionAttributeValuesEntries()
Removes all the entries added into ExpressionAttributeValues.
|
DeleteItemRequest |
clearKeyEntries()
Removes all the entries added into Key.
|
boolean |
equals(Object obj) |
String |
getConditionalOperator()
|
String |
getConditionExpression()
A condition that must be satisfied in order for a conditional
DeleteItem 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> |
getKey()
A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete.
|
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 deleted.
|
String |
getTableName()
The name of the table from which to delete 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
DeleteItem 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 |
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)
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 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)
|
DeleteItemRequest |
withConditionalOperator(String conditionalOperator)
|
DeleteItemRequest |
withConditionExpression(String conditionExpression)
A condition that must be satisfied in order for a conditional
DeleteItem to succeed.
|
DeleteItemRequest |
withExpected(Map<String,ExpectedAttributeValue> expected)
|
DeleteItemRequest |
withExpressionAttributeNames(Map<String,String> expressionAttributeNames)
One or more substitution tokens for attribute names in an expression.
|
DeleteItemRequest |
withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)
One or more values that can be substituted in an expression.
|
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)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
DeleteItemRequest |
withReturnConsumedCapacity(String returnConsumedCapacity)
A value that if set to
TOTAL , the response includes
ConsumedCapacity data for tables and indexes. |
DeleteItemRequest |
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. |
DeleteItemRequest |
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. |
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.
|
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public 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. For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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. For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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
setting 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. For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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
setting 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()
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
public void setKey(Map<String,AttributeValue> key)
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
key
- A map of attribute names to AttributeValue objects,
representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
public DeleteItemRequest withKey(Map<String,AttributeValue> key)
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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. For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
public void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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)IllegalArgumentException
public DeleteItemRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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)IllegalArgumentException
public DeleteItemRequest addKeyEntry(String key, AttributeValue value)
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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()
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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
public DeleteItemRequest 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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. 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.
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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
public DeleteItemRequest 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 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.
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
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.
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 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 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 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 type). If an item contains an AttributeValue
element 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 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 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 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
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"]}
.
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 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 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. This parameter does not
support attributes of type List or Map.
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()
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.
ConditionalOperator
public 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.
ConditionalOperator
public DeleteItemRequest 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.
ConditionalOperator
public 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.
ConditionalOperator
public DeleteItemRequest 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.
ConditionalOperator
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
- 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
- The content of the old item is
returned.
ReturnValue
public 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
- 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 setting is the default for ReturnValues.)
ALL_OLD
- The content of the old item is
returned.
ReturnValue
public DeleteItemRequest 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
- 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 setting is the default for ReturnValues.)
ALL_OLD
- The content of the old item is
returned.
ReturnValue
public 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
- 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 setting is the default for ReturnValues.)
ALL_OLD
- The content of the old item is
returned.
ReturnValue
public DeleteItemRequest 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
- 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 setting is the default for ReturnValues.)
ALL_OLD
- The content of the old item is
returned.
ReturnValue
public 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.ReturnConsumedCapacity
public 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.ReturnConsumedCapacity
public 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
- 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.ReturnConsumedCapacity
public 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.ReturnConsumedCapacity
public 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
- 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.ReturnConsumedCapacity
public 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.ReturnItemCollectionMetrics
public 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.ReturnItemCollectionMetrics
public DeleteItemRequest 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.ReturnItemCollectionMetrics
public 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.ReturnItemCollectionMetrics
public DeleteItemRequest 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.ReturnItemCollectionMetrics
public 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
DeleteItem 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 DeleteItemRequest 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
DeleteItem 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 DeleteItemRequest 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 DeleteItemRequest 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 DeleteItemRequest 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 DeleteItemRequest 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 DeleteItemRequest 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 DeleteItemRequest clearExpressionAttributeValuesEntries()
Returns a reference to this object so that method calls can be chained together.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2015. All rights reserved.