Class UpdateItemEnhancedRequest.Builder<T>
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest.Builder<T>
-
- Enclosing class:
- UpdateItemEnhancedRequest<T>
@NotThreadSafe public static final class UpdateItemEnhancedRequest.Builder<T> extends Object
A builder that is used to create a request with the desired parameters.Note: A valid request builder must define an item.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateItemEnhancedRequest<T>
build()
UpdateItemEnhancedRequest.Builder<T>
conditionExpression(Expression conditionExpression)
Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the update operation to succeed.UpdateItemEnhancedRequest.Builder<T>
ignoreNulls(Boolean ignoreNulls)
Sets if the update operation should ignore attributes with null values.UpdateItemEnhancedRequest.Builder<T>
item(T item)
Sets the item to write to DynamoDb.UpdateItemEnhancedRequest.Builder<T>
returnConsumedCapacity(String returnConsumedCapacity)
Whether to return the capacity consumed by this operation.UpdateItemEnhancedRequest.Builder<T>
returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Whether to return the capacity consumed by this operation.UpdateItemEnhancedRequest.Builder<T>
returnItemCollectionMetrics(String returnItemCollectionMetrics)
Whether to return the item collection metrics.UpdateItemEnhancedRequest.Builder<T>
returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Whether to return the item collection metrics.UpdateItemEnhancedRequest.Builder<T>
returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.UpdateItemEnhancedRequest.Builder<T>
returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
-
-
Method Detail
-
ignoreNulls
public UpdateItemEnhancedRequest.Builder<T> ignoreNulls(Boolean ignoreNulls)
Sets if the update operation should ignore attributes with null values. By default, the value is false.If set to true, any null values in the Java object will be ignored and not be updated on the persisted record. This is commonly referred to as a 'partial update'. If set to false, null values in the Java object will cause those attributes to be removed from the persisted record on update.
- Parameters:
ignoreNulls
- the boolean value- Returns:
- a builder of this type
-
conditionExpression
public UpdateItemEnhancedRequest.Builder<T> conditionExpression(Expression conditionExpression)
Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the update operation to succeed. If evaluating to false, the operation will not succeed.See
Expression
for condition syntax and examples.- Parameters:
conditionExpression
- a condition written as anExpression
- Returns:
- a builder of this type
-
item
public UpdateItemEnhancedRequest.Builder<T> item(T item)
Sets the item to write to DynamoDb. Required.- Parameters:
item
- the item to write- Returns:
- a builder of this type
-
returnConsumedCapacity
public UpdateItemEnhancedRequest.Builder<T> returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Whether to return the capacity consumed by this operation.
-
returnConsumedCapacity
public UpdateItemEnhancedRequest.Builder<T> returnConsumedCapacity(String returnConsumedCapacity)
Whether to return the capacity consumed by this operation.
-
returnItemCollectionMetrics
public UpdateItemEnhancedRequest.Builder<T> returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Whether to return the item collection metrics.
-
returnItemCollectionMetrics
public UpdateItemEnhancedRequest.Builder<T> returnItemCollectionMetrics(String returnItemCollectionMetrics)
Whether to return the item collection metrics.
-
returnValuesOnConditionCheckFailure
public UpdateItemEnhancedRequest.Builder<T> returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
returnValuesOnConditionCheckFailure
public UpdateItemEnhancedRequest.Builder<T> returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
build
public UpdateItemEnhancedRequest<T> build()
-
-