Package software.amazon.awssdk.enhanced.dynamodb.update

Class UpdateExpression

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.update.UpdateExpression

public final class UpdateExpression
extends Object

Contains sets of UpdateAction that represent the four DynamoDB update actions: SET, ADD, REMOVE and DELETE.

Use this class to build an immutable UpdateExpression with one or more UpdateAction. An UpdateExpression may be merged with another. When two UpdateExpression are merged, the actions of each group of UpdateAction, should they exist, are combined; all SET actions from each expression are concatenated, all REMOVE actions etc.

DynamoDb Enhanced will convert the UpdateExpression to a format readable by DynamoDb,

Example:-

 
 RemoveUpdateAction removeAction = ...
 SetUpdateAction setAction = ...
 UpdateExpression.builder()
                 .addAction(removeAction)
                 .addAction(setAction)
                 .build();
 
 

See respective subtype of UpdateAction, for example SetAction, for details on creating that action.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
List<AddAction>	addActions()
static UpdateExpression.Builder	builder()	Constructs a new builder for UpdateExpression.
List<DeleteAction>	deleteActions()
boolean	equals(Object o)
int	hashCode()
static UpdateExpression	mergeExpressions(UpdateExpression expression1, UpdateExpression expression2)	Merges two UpdateExpression, returning a new
List<RemoveAction>	removeActions()
List<SetAction>	setActions()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static UpdateExpression.Builder builder()

Constructs a new builder for UpdateExpression.

Returns:

a new builder.

removeActions

public List<RemoveAction> removeActions()

setActions

public List<SetAction> setActions()

deleteActions

public List<DeleteAction> deleteActions()

addActions

public List<AddAction> addActions()

mergeExpressions

public static UpdateExpression mergeExpressions(UpdateExpression expression1,
                                                UpdateExpression expression2)

Merges two UpdateExpression, returning a new

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object