Package software.amazon.awssdk.enhanced.dynamodb.update

Class DeleteAction

  • All Implemented Interfaces:
    UpdateAction, ToCopyableBuilder<DeleteAction.Builder,​DeleteAction>
    public final class DeleteAction
extends Object
implements UpdateAction, ToCopyableBuilder<DeleteAction.Builder,​DeleteAction>
    A representation of a single UpdateExpression DELETE action.

    At a minimum, this action must contain a path string referencing the attribute that should be acted upon and a value string referencing the value (subset) to be removed from the attribute. The value should be substituted with tokens using the ':value_token' syntax and values associated with the token must be explicitly added to the expressionValues map. Consult the DynamoDB UpdateExpression documentation for details on this action.

    Optionally, attribute names can be substituted with tokens using the '#name_token' syntax. If tokens are used in the expression then the names associated with those tokens must be explicitly added to the expressionNames map that is also stored on this object.

    Example:- 

     
 DeleteUpdateAction deleteAction = DeleteUpdateAction.builder()
                                                     .path("#a")
                                                     .value(":b")
                                                     .putExpressionName("#a", "attributeA")
                                                     .putExpressionValue(":b", myAttributeValue)
                                                     .build();