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
-
Method Summary
Modifier and TypeMethodDescriptionstatic RemoveAction.Builder
builder()
Constructs a new builder forRemoveAction
.boolean
int
hashCode()
path()
Take this object and create a builder that contains all of the current property values of this object.Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
builder
Constructs a new builder forRemoveAction
.- Returns:
- a new builder.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RemoveAction.Builder,
RemoveAction> - Returns:
- a builder for type T
-
path
-
expressionNames
-
equals
-
hashCode
public int hashCode()
-