Class TransactDeleteItemEnhancedRequest.Builder
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.TransactDeleteItemEnhancedRequest.Builder
-
- Enclosing class:
- TransactDeleteItemEnhancedRequest
@NotThreadSafe public static final class TransactDeleteItemEnhancedRequest.Builder extends Object
A builder that is used to create a request with the desired parameters.Note: A valid request builder must define a
Key
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TransactDeleteItemEnhancedRequest
build()
TransactDeleteItemEnhancedRequest.Builder
conditionExpression(Expression conditionExpression)
Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the delete operation to succeed.TransactDeleteItemEnhancedRequest.Builder
key(Consumer<Key.Builder> keyConsumer)
Sets the primaryKey
that will be used to match the item to delete on the builder by accepting a consumer ofKey.Builder
.TransactDeleteItemEnhancedRequest.Builder
key(Key key)
Sets the primaryKey
that will be used to match the item to delete.TransactDeleteItemEnhancedRequest.Builder
returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
UseReturnValuesOnConditionCheckFailure
to get the item attributes if theDelete
condition fails.TransactDeleteItemEnhancedRequest.Builder
returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
UseReturnValuesOnConditionCheckFailure
to get the item attributes if theDelete
condition fails.
-
-
-
Method Detail
-
key
public TransactDeleteItemEnhancedRequest.Builder key(Key key)
Sets the primaryKey
that will be used to match the item to delete.- Parameters:
key
- the primary key to use in the request.- Returns:
- a builder of this type
-
key
public TransactDeleteItemEnhancedRequest.Builder key(Consumer<Key.Builder> keyConsumer)
Sets the primaryKey
that will be used to match the item to delete on the builder by accepting a consumer ofKey.Builder
.
-
conditionExpression
public TransactDeleteItemEnhancedRequest.Builder conditionExpression(Expression conditionExpression)
Defines a logical expression on an item's attribute values which, if evaluating to true, will allow the delete 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
-
returnValuesOnConditionCheckFailure
public TransactDeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
UseReturnValuesOnConditionCheckFailure
to get the item attributes if theDelete
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 TransactDeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
UseReturnValuesOnConditionCheckFailure
to get the item attributes if theDelete
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
public TransactDeleteItemEnhancedRequest build()
-
-