@Beta public final class BS extends PathOperand
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 Details

    • eq

      public ComparatorCondition 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.
    • eq

      public ComparatorCondition 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.
    • eq

      public ComparatorCondition eq(BS 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(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.
    • ne

      public ComparatorCondition 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.
    • ne

      public ComparatorCondition ne(BS 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(byte[] value)
      Returns an FunctionCondition 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

      public FunctionCondition contains(ByteBuffer value)
      Returns an FunctionCondition 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(byte[]... value)
      Returns a SetAction 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(ByteBuffer... value)
      Returns a SetAction 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

      public AddAction append(byte[]... values)
      Returns an AddAction 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

      public AddAction append(ByteBuffer... values)
      Returns an AddAction 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

      public DeleteAction delete(byte[]... values)
      Returns a DeleteAction for deleting the specified values from this binary set.
    • delete

      public DeleteAction delete(ByteBuffer... values)
      Returns a DeleteAction for deleting the specified values from this binary set.
    • ifNotExists

      public IfNotExistsFunction<BS> ifNotExists(byte[]... defaultValue)
      Returns an IfNotExistsFunction 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<BS> ifNotExists(ByteBuffer... defaultValue)
      Returns an IfNotExistsFunction 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<BS> ifNotExists(BS defaultValue)
      Returns an IfNotExistsFunction 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

      public SetAction set(BS source)
      Returns a SetAction 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

      public SetAction set(Set<byte[]> value)
      Returns a SetAction 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<BS> ifNotExistsFunction)
      Returns a SetAction 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 specified IfNotExists 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 specified IfNotExists function.