software.amazon.awssdk.enhanced.dynamodb.update

Class DeleteAction

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.update.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();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteAction.Builder A builder for DeleteAction

Method Summary

Modifier and Type	Method and Description
static DeleteAction.Builder	builder() Constructs a new builder for DeleteAction.
boolean	equals(Object o)
Map<String,String>	expressionNames()
Map<String,AttributeValue>	expressionValues()
int	hashCode()
String	path()
DeleteAction.Builder	toBuilder()
String	value()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

builder

public static DeleteAction.Builder builder()

Constructs a new builder for DeleteAction.

Returns:

a new builder.

toBuilder

public DeleteAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteAction.Builder,DeleteAction>

path

public String path()

value

public String value()

expressionNames

public Map<String,String> expressionNames()

expressionValues

public Map<String,AttributeValue> expressionValues()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object