software.amazon.awssdk.enhanced.dynamodb.update

Class RemoveAction

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.update.RemoveAction

All Implemented Interfaces:

UpdateAction, ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

public final class RemoveAction
extends Object
implements UpdateAction, ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

A representation of a single UpdateExpression REMOVE action.

At a minimum, this action must contain a path string referencing the attribute that should be removed when applying this action. 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:-

 
 RemoveUpdateAction removeAction = RemoveUpdateAction.builder()
                                                     .path("#a")
                                                     .putExpressionName("#a", "attributeA")
                                                     .build();
 
 

Nested Class Summary

Nested Classes

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

Method Summary

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

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 RemoveAction.Builder builder()

Constructs a new builder for RemoveAction.

Returns:

a new builder.

toBuilder

public RemoveAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RemoveAction.Builder,RemoveAction>

path

public String path()

expressionNames

public Map<String,String> expressionNames()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object