Class ExpectedAttributeValue
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ExpectedAttributeValue.Builder,ExpectedAttributeValue>
Represents a condition to be compared with an attribute value. This condition can be used with
DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to
true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of
two different ways:
-
Use
AttributeValueListto specify one or more values to compare against an attribute. UseComparisonOperatorto specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds. -
Use
Valueto specify a value that DynamoDB will compare against an attribute. If the values match, thenExpectedAttributeValueevaluates to true and the conditional operation succeeds. Optionally, you can also setExiststo false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.
Value and Exists are incompatible with AttributeValueList and
ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a
ValidationException exception.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<AttributeValue> One or more values to evaluate against the supplied attribute.builder()final ComparisonOperatorA comparator for evaluating attributes in theAttributeValueList.final StringA comparator for evaluating attributes in theAttributeValueList.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Booleanexists()Causes DynamoDB to evaluate the value before attempting a conditional operation:final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the AttributeValueList property.final inthashCode()static Class<? extends ExpectedAttributeValue.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final AttributeValuevalue()Represents the data for the expected attribute.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
value
Represents the data for the expected attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
- Returns:
- Represents the data for the expected attribute.
Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.
For more information, see Data Types in the Amazon DynamoDB Developer Guide.
-
exists
Causes DynamoDB to evaluate the value before attempting a conditional operation:
-
If
Existsistrue, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with aConditionCheckFailedException. -
If
Existsisfalse, 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 operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with aConditionCheckFailedException.
The default setting for
Existsistrue. If you supply aValueall by itself, DynamoDB assumes the attribute exists: You don't have to setExiststotrue, because it is implied.DynamoDB returns a
ValidationExceptionif:-
Existsistruebut there is noValueto check. (You expect a value to exist, but don't specify what that value is.) -
Existsisfalsebut you also provide aValue. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
- Returns:
- Causes DynamoDB to evaluate the value before attempting a conditional operation:
-
If
Existsistrue, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with aConditionCheckFailedException. -
If
Existsisfalse, 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 operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with aConditionCheckFailedException.
The default setting for
Existsistrue. If you supply aValueall by itself, DynamoDB assumes the attribute exists: You don't have to setExiststotrue, because it is implied.DynamoDB returns a
ValidationExceptionif:-
Existsistruebut there is noValueto check. (You expect a value to exist, but don't specify what that value is.) -
Existsisfalsebut you also provide aValue. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
-
-
-
comparisonOperator
A comparator for evaluating attributes in the
AttributeValueList. For example, equals, greater than, less than, etc.The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEENThe following are descriptions of each comparison operator.
-
EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
NE: Not equal.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
LE: Less than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
LT: Less than.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GE: Greater than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GT: Greater than.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
NOT_NULL: The attribute exists.NOT_NULLis supported for all data types, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNOT_NULL, the result is a Booleantrue. This result is because the attribute "a" exists; its data type is not relevant to theNOT_NULLcomparison operator. -
NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNULL, the result is a Booleanfalse. This is because the attribute "a" exists; its data type is not relevant to theNULLcomparison operator. -
CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not compare to{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}
If the service returns an enum value that is not available in the current SDK version,
comparisonOperatorwill returnComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomparisonOperatorAsString().- Returns:
- A comparator for evaluating attributes in the
AttributeValueList. For example, equals, greater than, less than, etc.The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEENThe following are descriptions of each comparison operator.
-
EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
NE: Not equal.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
LE: Less than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
LT: Less than.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GE: Greater than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GT: Greater than.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
NOT_NULL: The attribute exists.NOT_NULLis supported for all data types, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNOT_NULL, the result is a Booleantrue. This result is because the attribute "a" exists; its data type is not relevant to theNOT_NULLcomparison operator. -
NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNULL, the result is a Booleanfalse. This is because the attribute "a" exists; its data type is not relevant to theNULLcomparison operator. -
CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not compare to{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}
-
- See Also:
-
-
comparisonOperatorAsString
A comparator for evaluating attributes in the
AttributeValueList. For example, equals, greater than, less than, etc.The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEENThe following are descriptions of each comparison operator.
-
EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
NE: Not equal.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
LE: Less than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
LT: Less than.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GE: Greater than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GT: Greater than.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
NOT_NULL: The attribute exists.NOT_NULLis supported for all data types, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNOT_NULL, the result is a Booleantrue. This result is because the attribute "a" exists; its data type is not relevant to theNOT_NULLcomparison operator. -
NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNULL, the result is a Booleanfalse. This is because the attribute "a" exists; its data type is not relevant to theNULLcomparison operator. -
CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not compare to{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}
If the service returns an enum value that is not available in the current SDK version,
comparisonOperatorwill returnComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcomparisonOperatorAsString().- Returns:
- A comparator for evaluating attributes in the
AttributeValueList. For example, equals, greater than, less than, etc.The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEENThe following are descriptions of each comparison operator.
-
EQ: Equal.EQis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
NE: Not equal.NEis supported for all data types, including lists and maps.AttributeValueListcan contain only oneAttributeValueof type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValueof a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not equal{"NS":["6", "2", "1"]}. -
LE: Less than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
LT: Less than.AttributeValueListcan contain only oneAttributeValueof type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GE: Greater than or equal.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
GT: Greater than.AttributeValueListcan contain only oneAttributeValueelement of type String, Number, or Binary (not a set type). If an item contains anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not equal{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}. -
NOT_NULL: The attribute exists.NOT_NULLis supported for all data types, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNOT_NULL, the result is a Booleantrue. This result is because the attribute "a" exists; its data type is not relevant to theNOT_NULLcomparison operator. -
NULL: The attribute does not exist.NULLis supported for all data types, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a" is null, and you evaluate it usingNULL, the result is a Booleanfalse. This is because the attribute "a" exists; its data type is not relevant to theNULLcomparison operator. -
CONTAINS: Checks for a subsequence, or value in a set.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueelement 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.AttributeValueListcan contain only oneAttributeValueof 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 in a list.AttributeValueListcan contain one or moreAttributeValueelements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to 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.AttributeValueListmust contain twoAttributeValueelements 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 anAttributeValueelement of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}does not compare to{"N":"6"}. Also,{"N":"6"}does not compare to{"NS":["6", "2", "1"]}
-
- See Also:
-
-
hasAttributeValueList
public final boolean hasAttributeValueList()For responses, this returns true if the service returned a value for the AttributeValueList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
attributeValueList
One or more values to evaluate against the supplied attribute. The number of values in the list depends on the
ComparisonOperatorbeing 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,
ais greater thanA, andais greater thanB. For a list of code values, see http://en.wikipedia .org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributeValueList()method.- Returns:
- One or more values to evaluate against the supplied attribute. The number of values in the list depends
on the
ComparisonOperatorbeing 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,
ais greater thanA, andais greater thanB. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ExpectedAttributeValue.Builder,ExpectedAttributeValue> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-