Class SS
- java.lang.Object
-
- com.amazonaws.services.dynamodbv2.xspec.Operand
-
- com.amazonaws.services.dynamodbv2.xspec.PathOperand
-
- com.amazonaws.services.dynamodbv2.xspec.SS
-
@Beta public final class SS extends PathOperand
A path operand that refers to a string set attribute in DynamoDB; used for building expressions.Use
ExpressionSpecBuilder.SS(String)
to instantiate this class.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddAction
append(String... values)
Returns anAddAction
for building expression that would append the specified values to this string set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.AddAction
append(Set<String> values)
Returns anAddAction
for building expression that would append the specified values to this string set; or if the attribute does not already exist, add the new attribute and the value(s) to the item.FunctionCondition
contains(String 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.DeleteAction
delete(String... values)
Returns aDeleteAction
for deleting the specified values from this string set.DeleteAction
delete(Set<String> values)
Returns aDeleteAction
for deleting the specified values from this string set.ComparatorCondition
eq(SS that)
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.ComparatorCondition
eq(String... 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.ComparatorCondition
eq(Set<String> value)
Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is equal to the specified value) for building condition expression.IfNotExistsFunction<SS>
ifNotExists(SS 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.IfNotExistsFunction<SS>
ifNotExists(String... 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.IfNotExistsFunction<SS>
ifNotExists(Set<String> defaultValue)
Returns anIfNotExists
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.ComparatorCondition
ne(SS that)
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.ComparatorCondition
ne(String... 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.ComparatorCondition
ne(Set<String> value)
Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is not equal to that of the specified path operand) for building condition expression.SetAction
set(IfNotExistsFunction<SS> ifNotExistsFunction)
Returns aSetAction
object used for building update expression.SetAction
set(SS source)
Returns aSetAction
object used for building update expression.SetAction
set(String... values)
Returns aSetAction
object used for building update expression.SetAction
set(Set<String> value)
Returns aSetAction
object used for building update expression.
-
-
-
Method Detail
-
eq
public ComparatorCondition eq(String... 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.
-
eq
public ComparatorCondition eq(SS that)
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
public ComparatorCondition ne(String... 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.
-
ne
public ComparatorCondition ne(SS that)
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
public FunctionCondition contains(String 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 (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
public final SetAction set(String... values)
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
public final SetAction set(SS source)
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.
-
append
public AddAction append(String... values)
Returns anAddAction
for building expression that would append the specified values to this string 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
public AddAction append(Set<String> values)
Returns anAddAction
for building expression that would append the specified values to this string 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
public DeleteAction delete(String... values)
Returns aDeleteAction
for deleting the specified values from this string set.
-
delete
public DeleteAction delete(Set<String> values)
Returns aDeleteAction
for deleting the specified values from this string set.
-
ifNotExists
public IfNotExistsFunction<SS> ifNotExists(String... 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."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
public IfNotExistsFunction<SS> ifNotExists(SS 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."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 string set attribute) that will be used as the operand to the if_not_exists function call.
-
set
public SetAction set(Set<String> value)
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
public SetAction set(IfNotExistsFunction<SS> ifNotExistsFunction)
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.
-
eq
public ComparatorCondition eq(Set<String> value)
Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is equal to the specified value) for building condition expression.
-
ne
public ComparatorCondition ne(Set<String> value)
Returns a comparator condition (that evaluates to true if the attribute value referred to by this path operand is not equal to that of the specified path operand) for building condition expression.
-
ifNotExists
public IfNotExistsFunction<SS> ifNotExists(Set<String> defaultValue)
Returns anIfNotExists
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.
-
-