Interface ExpectedAttributeValue.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<ExpectedAttributeValue.Builder,ExpectedAttributeValue>
,SdkBuilder<ExpectedAttributeValue.Builder,ExpectedAttributeValue>
,SdkPojo
- Enclosing class:
- ExpectedAttributeValue
public static interface ExpectedAttributeValue.Builder extends SdkPojo, CopyableBuilder<ExpectedAttributeValue.Builder,ExpectedAttributeValue>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ExpectedAttributeValue.Builder
attributeValueList(Collection<AttributeValue> attributeValueList)
One or more values to evaluate against the supplied attribute.ExpectedAttributeValue.Builder
attributeValueList(Consumer<AttributeValue.Builder>... attributeValueList)
One or more values to evaluate against the supplied attribute.ExpectedAttributeValue.Builder
attributeValueList(AttributeValue... attributeValueList)
One or more values to evaluate against the supplied attribute.ExpectedAttributeValue.Builder
comparisonOperator(String comparisonOperator)
A comparator for evaluating attributes in theAttributeValueList
.ExpectedAttributeValue.Builder
comparisonOperator(ComparisonOperator comparisonOperator)
A comparator for evaluating attributes in theAttributeValueList
.ExpectedAttributeValue.Builder
exists(Boolean exists)
Causes DynamoDB to evaluate the value before attempting a conditional operation:default ExpectedAttributeValue.Builder
value(Consumer<AttributeValue.Builder> value)
Represents the data for the expected attribute.ExpectedAttributeValue.Builder
value(AttributeValue value)
Represents the data for the expected attribute.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
value
ExpectedAttributeValue.Builder value(AttributeValue 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
value
default ExpectedAttributeValue.Builder value(Consumer<AttributeValue.Builder> 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.
This is a convenience method that creates an instance of theAttributeValue.Builder
avoiding the need to create one manually viaAttributeValue.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalue(AttributeValue)
.- Parameters:
value
- a consumer that will call methods onAttributeValue.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
value(AttributeValue)
-
exists
ExpectedAttributeValue.Builder exists(Boolean exists)
Causes DynamoDB to evaluate the value before attempting a conditional operation:
-
If
Exists
istrue
, 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
Exists
isfalse
, 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
Exists
istrue
. If you supply aValue
all by itself, DynamoDB assumes the attribute exists: You don't have to setExists
totrue
, because it is implied.DynamoDB returns a
ValidationException
if:-
Exists
istrue
but there is noValue
to check. (You expect a value to exist, but don't specify what that value is.) -
Exists
isfalse
but you also provide aValue
. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
- Parameters:
exists
- Causes DynamoDB to evaluate the value before attempting a conditional operation:-
If
Exists
istrue
, 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
Exists
isfalse
, 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
Exists
istrue
. If you supply aValue
all by itself, DynamoDB assumes the attribute exists: You don't have to setExists
totrue
, because it is implied.DynamoDB returns a
ValidationException
if:-
Exists
istrue
but there is noValue
to check. (You expect a value to exist, but don't specify what that value is.) -
Exists
isfalse
but you also provide aValue
. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
comparisonOperator
ExpectedAttributeValue.Builder comparisonOperator(String 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 | BETWEEN
The following are descriptions of each comparison operator.
-
EQ
: Equal.EQ
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
NE
: Not equal.NE
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
LE
: Less than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
LT
: Less than.AttributeValueList
can contain only oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GE
: Greater than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GT
: Greater than.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is 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_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is 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 theNULL
comparison operator. -
CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 in a list.AttributeValueList
can contain one or moreAttributeValue
elements 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.AttributeValueList
must contain twoAttributeValue
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 anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not compare to{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
- Parameters:
comparisonOperator
- A comparator for evaluating attributes in theAttributeValueList
. 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 | BETWEEN
The following are descriptions of each comparison operator.
-
EQ
: Equal.EQ
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
NE
: Not equal.NE
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
LE
: Less than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
LT
: Less than.AttributeValueList
can contain only oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GE
: Greater than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GT
: Greater than.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is 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_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is 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 theNULL
comparison operator. -
CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 in a list.AttributeValueList
can contain one or moreAttributeValue
elements 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.AttributeValueList
must contain twoAttributeValue
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 anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not compare to{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ComparisonOperator
,ComparisonOperator
-
-
comparisonOperator
ExpectedAttributeValue.Builder comparisonOperator(ComparisonOperator 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 | BETWEEN
The following are descriptions of each comparison operator.
-
EQ
: Equal.EQ
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
NE
: Not equal.NE
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
LE
: Less than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
LT
: Less than.AttributeValueList
can contain only oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GE
: Greater than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GT
: Greater than.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is 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_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is 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 theNULL
comparison operator. -
CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 in a list.AttributeValueList
can contain one or moreAttributeValue
elements 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.AttributeValueList
must contain twoAttributeValue
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 anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not compare to{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
- Parameters:
comparisonOperator
- A comparator for evaluating attributes in theAttributeValueList
. 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 | BETWEEN
The following are descriptions of each comparison operator.
-
EQ
: Equal.EQ
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
NE
: Not equal.NE
is supported for all data types, including lists and maps.AttributeValueList
can contain only oneAttributeValue
of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains anAttributeValue
of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not equal{"NS":["6", "2", "1"]}
. -
LE
: Less than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
LT
: Less than.AttributeValueList
can contain only oneAttributeValue
of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GE
: Greater than or equal.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
GT
: Greater than.AttributeValueList
can contain only oneAttributeValue
element of type String, Number, or Binary (not a set type). If an item contains anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not equal{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is 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_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is 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 theNULL
comparison operator. -
CONTAINS
: Checks for a subsequence, or value in a set.AttributeValueList
can contain only oneAttributeValue
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 oneAttributeValue
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 oneAttributeValue
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 in a list.AttributeValueList
can contain one or moreAttributeValue
elements 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.AttributeValueList
must contain twoAttributeValue
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 anAttributeValue
element of a different type than the one provided in the request, the value does not match. For example,{"S":"6"}
does not compare to{"N":"6"}
. Also,{"N":"6"}
does not compare to{"NS":["6", "2", "1"]}
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ComparisonOperator
,ComparisonOperator
-
-
attributeValueList
ExpectedAttributeValue.Builder attributeValueList(Collection<AttributeValue> 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 thanA
, anda
is 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.
- Parameters:
attributeValueList
- One or more values to evaluate against the supplied attribute. The number of values in the list depends on theComparisonOperator
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 thanA
, anda
is 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeValueList
ExpectedAttributeValue.Builder attributeValueList(AttributeValue... 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 thanA
, anda
is 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.
- Parameters:
attributeValueList
- One or more values to evaluate against the supplied attribute. The number of values in the list depends on theComparisonOperator
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 thanA
, anda
is 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributeValueList
ExpectedAttributeValue.Builder attributeValueList(Consumer<AttributeValue.Builder>... 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 thanA
, anda
is 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.
This is a convenience method that creates an instance of theAttributeValue.Builder
avoiding the need to create one manually viaAttributeValue.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#attributeValueList(List
.) - Parameters:
attributeValueList
- a consumer that will call methods onAttributeValue.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#attributeValueList(java.util.Collection
)
-
-