Class UpdateItemEnhancedRequest<T>
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest<T>
-
- Type Parameters:
T- The type of the modelled object.
@ThreadSafe public final class UpdateItemEnhancedRequest<T> extends Object
Defines parameters used to update an item to a DynamoDb table using the updateItem() operation (such asDynamoDbTable.updateItem(UpdateItemEnhancedRequest)orDynamoDbAsyncTable.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 classUpdateItemEnhancedRequest.Builder<T>A builder that is used to create a request with the desired parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <T> UpdateItemEnhancedRequest.Builder<T>builder(Class<? extends T> itemClass)Creates a newly initialized builder for the request object.ExpressionconditionExpression()Returns the conditionExpressionset on this request object, or null if it doesn't exist.booleanequals(Object o)inthashCode()BooleanignoreNulls()Deprecated.IgnoreNullsModeignoreNullsMode()Returns the mode of update to be performedTitem()Returns the item for this update operation request.ReturnConsumedCapacityreturnConsumedCapacity()Whether to return the capacity consumed by this operation.StringreturnConsumedCapacityAsString()Whether to return the capacity consumed by this operation.ReturnItemCollectionMetricsreturnItemCollectionMetrics()Whether to return the item collection metrics.StringreturnItemCollectionMetricsAsString()Whether to return the item collection metrics.ReturnValuereturnValues()Whether to return the values of the item before this request.StringreturnValuesAsString()Whether to return the values of the item before this request.ReturnValuesOnConditionCheckFailurereturnValuesOnConditionCheckFailure()Whether to return the item on condition check failure.StringreturnValuesOnConditionCheckFailureAsString()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.
-
-
-
Method Detail
-
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 conditionExpressionset 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 inReturnValue.
-
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 inReturnConsumedCapacity.
-
returnItemCollectionMetrics
public ReturnItemCollectionMetrics returnItemCollectionMetrics()
Whether to return the item collection metrics.
-
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 inReturnItemCollectionMetrics.
-
returnValuesOnConditionCheckFailure
public ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure()
Whether to return the item on condition check failure.
-
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 inReturnValuesOnConditionCheckFailure.
-
-