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 singleUpdateExpression
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 Description static class
RemoveAction.Builder
A builder forRemoveAction
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RemoveAction.Builder
builder()
Constructs a new builder forRemoveAction
.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 forRemoveAction
.- Returns:
- a new builder.
-
toBuilder
public RemoveAction.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RemoveAction.Builder,RemoveAction>
-
path
public String path()
-
-