Class TransactUpdateItemEnhancedRequest.Builder<T>
java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.model.TransactUpdateItemEnhancedRequest.Builder<T>
- Enclosing class:
TransactUpdateItemEnhancedRequest<T>
@NotThreadSafe
public static final class TransactUpdateItemEnhancedRequest.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
Modifier and TypeMethodDescriptionbuild()
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.ignoreNulls
(Boolean ignoreNulls) Sets if the update operation should ignore attributes with null values.Sets the item to write to DynamoDb.returnValuesOnConditionCheckFailure
(String returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theConditionCheck
condition fails.returnValuesOnConditionCheckFailure
(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theConditionCheck
condition fails.
-
Method Details
-
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 TransactUpdateItemEnhancedRequest.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
Sets the item to write to DynamoDb. Required.- Parameters:
item
- the item to write- Returns:
- a builder of this type
-
returnValuesOnConditionCheckFailure
public TransactUpdateItemEnhancedRequest.Builder<T> returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theConditionCheck
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Parameters:
returnValuesOnConditionCheckFailure
- What values to return on condition check failure.- Returns:
- a builder of this type
-
returnValuesOnConditionCheckFailure
public TransactUpdateItemEnhancedRequest.Builder<T> returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure) UseReturnValuesOnConditionCheckFailure
to get the item attributes if theConditionCheck
condition fails. ForReturnValuesOnConditionCheckFailure
, the valid values are: NONE and ALL_OLD.- Parameters:
returnValuesOnConditionCheckFailure
- What values to return on condition check failure.- Returns:
- a builder of this type
-
build
-