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
-
Method Summary
Modifier and TypeMethodDescriptionstatic DeleteAction.Builder
builder()
Constructs a new builder forDeleteAction
.boolean
int
hashCode()
path()
Take this object and create a builder that contains all of the current property values of this object.value()
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 forDeleteAction
.- 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<DeleteAction.Builder,
DeleteAction> - Returns:
- a builder for type T
-
path
-
value
-
expressionNames
-
expressionValues
-
equals
-
hashCode
public int hashCode()
-