Class UpdateItemEnhancedRequest<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest<T>

Type Parameters:

T - The type of the modelled object.

@SdkPublicApi
@ThreadSafe
public final class UpdateItemEnhancedRequest<T>
extends Object

Defines parameters used to update an item to a DynamoDb table using the updateItem() operation (such as DynamoDbTable.updateItem(UpdateItemEnhancedRequest) or DynamoDbAsyncTable.updateItem(UpdateItemEnhancedRequest)).

A valid request object must contain the item that should be written to the table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UpdateItemEnhancedRequest.Builder<T>	A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method	Description
static <T> UpdateItemEnhancedRequest.Builder<T>	builder(Class<? extends T> itemClass)	Creates a newly initialized builder for the request object.
Expression	conditionExpression()	Returns the condition Expression set on this request object, or null if it doesn't exist.
boolean	equals(Object o)
int	hashCode()
Boolean	ignoreNulls()	Deprecated.
IgnoreNullsMode	ignoreNullsMode()	Returns the mode of update to be performed
T	item()	Returns the item for this update operation request.
ReturnConsumedCapacity	returnConsumedCapacity()	Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString()	Whether to return the capacity consumed by this operation.
ReturnItemCollectionMetrics	returnItemCollectionMetrics()	Whether to return the item collection metrics.
String	returnItemCollectionMetricsAsString()	Whether to return the item collection metrics.
ReturnValue	returnValues()	Whether to return the values of the item before this request.
String	returnValuesAsString()	Whether to return the values of the item before this request.
ReturnValuesOnConditionCheckFailure	returnValuesOnConditionCheckFailure()	Whether to return the item on condition check failure.
String	returnValuesOnConditionCheckFailureAsString()	Whether to return the item on condition check failure.
UpdateItemEnhancedRequest.Builder<T>	toBuilder()	Returns a builder initialized with all existing values on the request object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static <T>
UpdateItemEnhancedRequest.Builder<T> builder(Class<? extends T> itemClass)

Creates a newly initialized builder for the request object.

Type Parameters:

T - The type of the modelled object, corresponding to itemClass

Parameters:

itemClass - the class that items in this table map to

Returns:

a UpdateItemEnhancedRequest builder

toBuilder

public UpdateItemEnhancedRequest.Builder<T> toBuilder()

Returns a builder initialized with all existing values on the request object.

item

public T item()

Returns the item for this update operation request.

ignoreNulls

@Deprecated
public Boolean ignoreNulls()

Deprecated.

Returns if the update operation should ignore attributes with null values, or false if it has not been set. This is deprecated in favour of ignoreNullsMode()

ignoreNullsMode

public IgnoreNullsMode ignoreNullsMode()

Returns the mode of update to be performed

conditionExpression

public Expression conditionExpression()

Returns the condition Expression set on this request object, or null if it doesn't exist.

returnValues

public ReturnValue returnValues()

Whether to return the values of the item before this request.

See Also:

• UpdateItemRequest.returnValues()

returnValuesAsString

public String returnValuesAsString()

Whether to return the values of the item before this request.

Similar to returnValues() but returns the value as a string. This is useful in situations where the value is not defined in ReturnValue.

returnConsumedCapacity

public ReturnConsumedCapacity returnConsumedCapacity()

Whether to return the capacity consumed by this operation.

See Also:

• PutItemRequest.returnConsumedCapacity()

returnConsumedCapacityAsString

public String returnConsumedCapacityAsString()

Whether to return the capacity consumed by this operation.

Similar to returnConsumedCapacity() but return the value as a string. This is useful in situations where the value is not defined in ReturnConsumedCapacity.

returnItemCollectionMetrics

public ReturnItemCollectionMetrics returnItemCollectionMetrics()

Whether to return the item collection metrics.

See Also:

• DeleteItemRequest.returnItemCollectionMetrics()

returnItemCollectionMetricsAsString

public String returnItemCollectionMetricsAsString()

Whether to return the item collection metrics.

Similar to returnItemCollectionMetrics() but return the value as a string. This is useful in situations where the value is not defined in ReturnItemCollectionMetrics.

returnValuesOnConditionCheckFailure

public ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()

Whether to return the item on condition check failure.

See Also:

• UpdateItemRequest.returnValuesOnConditionCheckFailure()

returnValuesOnConditionCheckFailureAsString

public String returnValuesOnConditionCheckFailureAsString()

Whether to return the item on condition check failure.

Similar to returnValuesOnConditionCheckFailure() but return the value as a string. This is useful in situations where the value is not defined in ReturnValuesOnConditionCheckFailure.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object