Class BS
java.lang.Object
com.amazonaws.services.dynamodbv2.xspec.Operand
com.amazonaws.services.dynamodbv2.xspec.PathOperand
com.amazonaws.services.dynamodbv2.xspec.BS
A path operand that refers to a binary set attribute in DynamoDB; used for building expressions.
Use ExpressionSpecBuilder.BS(String)
to instantiate this class.
-
Method Summary
Modifier and TypeMethodDescriptionappend
(byte[]... values) Returns anAddAction
for build expression that would append the specified values to this binary set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.append
(ByteBuffer... values) Returns anAddAction
for build expression that would append the specified values to this binary set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.contains
(byte[] value) Returns anFunctionCondition
object which represents an contains(path, operand) function condition where path refers to that of the current path operand; used for building expressions.contains
(ByteBuffer value) Returns anFunctionCondition
object which represents an contains(path, operand) function condition where path refers to that of the current path operand; used for building expressions.delete
(byte[]... values) Returns aDeleteAction
for deleting the specified values from this binary set.delete
(ByteBuffer... values) Returns aDeleteAction
for deleting the specified values from this binary set.eq
(byte[]... values) Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to the set of specified values) for building condition expression.Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to that of the specified attribute) for building condition expression.eq
(ByteBuffer... values) Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to the set of specified values) for building condition expression.ifNotExists
(byte[]... defaultValue) Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions.ifNotExists
(BS defaultValue) Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions.ifNotExists
(ByteBuffer... defaultValue) Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions.ne
(byte[]... values) Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to the set of specified values) for building condition expression.Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to that of the specified attribute) for building condition expression.ne
(ByteBuffer... values) Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to the set of specified values) for building condition expression.final SetAction
set
(byte[]... value) Returns aSetAction
object used for building update expression.Returns aSetAction
object used for building update expression.set
(IfNotExistsFunction<BS> ifNotExistsFunction) Returns aSetAction
object used for building update expression.final SetAction
set
(ByteBuffer... value) Returns aSetAction
object used for building update expression.Returns aSetAction
object used for building update expression.
-
Method Details
-
eq
Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to the set of specified values) for building condition expression. -
eq
Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to the set of specified values) for building condition expression. -
eq
Returns a comparator condition (that evaluates to true if the value of the current attribute is equal to that of the specified attribute) for building condition expression. -
ne
Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to the set of specified values) for building condition expression. -
ne
Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to the set of specified values) for building condition expression. -
ne
Returns a comparator condition (that evaluates to true if the value of the current attribute is not equal to that of the specified attribute) for building condition expression. -
contains
Returns anFunctionCondition
object which represents an contains(path, operand) function condition where path refers to that of the current path operand; used for building expressions."contains (path, operand) — true if the attribute at the specified path contains a particular operand. Note that the path and the operand must be distinct; that is, contains (a, a) will return an error"
- Parameters:
value
- the value that will be used as the operand to the "contains" function condition.
-
contains
Returns anFunctionCondition
object which represents an contains(path, operand) function condition where path refers to that of the current path operand; used for building expressions."contains (path, operand) — true if the attribute at the specified path contains a particular operand. Note that the path and the operand must be distinct; that is, contains (a, a) will return an error"
- Parameters:
value
- the value that will be used as the operand to the "contains" function condition.
-
set
Returns aSetAction
object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the specified value as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the specified value. -
set
Returns aSetAction
object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the specified value as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the specified value. -
append
Returns anAddAction
for build expression that would append the specified values to this binary set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.In general, DynamoDB recommends using SET rather than ADD.
-
append
Returns anAddAction
for build expression that would append the specified values to this binary set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.In general, DynamoDB recommends using SET rather than ADD.
-
delete
Returns aDeleteAction
for deleting the specified values from this binary set. -
delete
Returns aDeleteAction
for deleting the specified values from this binary set. -
ifNotExists
Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions."if_not_exists (path, operand) – If the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute already present in the item."
- Parameters:
defaultValue
- the default value that will be used as the operand to the if_not_exists function call.
-
ifNotExists
Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions."if_not_exists (path, operand) – If the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute already present in the item."
- Parameters:
defaultValue
- the default value that will be used as the operand to the if_not_exists function call.
-
ifNotExists
Returns anIfNotExistsFunction
object which represents an if_not_exists(path, operand) function call where path refers to that of the current path operand; used for building expressions."if_not_exists (path, operand) – If the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute already present in the item."
- Parameters:
defaultValue
- the default value (of another binary set attribute) that will be used as the operand to the if_not_exists function call.
-
set
Returns aSetAction
object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the attribute value of the specified source path operand to an item. If the current attribute already exists, the returned object represents the value replacement of the current attribute by the attribute value of the specified source path operand. -
set
Returns aSetAction
object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the specified value as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the specified value. -
set
Returns aSetAction
object used for building update expression. If the attribute referred to by this path operand doesn't exist, the returned object represents adding the value of evaluating the specifiedIfNotExists
function as an attribute to an item. If the attribute referred to by this path operand already exists, the returned object represents the value replacement of the current attribute by the value of evaluating the specifiedIfNotExists
function.
-