Class DeleteItemEnhancedRequest.Builder
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest.Builder
-
- Enclosing class:
- DeleteItemEnhancedRequest
@NotThreadSafe public static final class DeleteItemEnhancedRequest.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 DeleteItemEnhancedRequest
build()
DeleteItemEnhancedRequest.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.DeleteItemEnhancedRequest.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
.DeleteItemEnhancedRequest.Builder
key(Key key)
Sets the primaryKey
that will be used to match the item to delete.DeleteItemEnhancedRequest.Builder
returnConsumedCapacity(String returnConsumedCapacity)
Whether to return the capacity consumed by this operation.DeleteItemEnhancedRequest.Builder
returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Whether to return the capacity consumed by this operation.DeleteItemEnhancedRequest.Builder
returnItemCollectionMetrics(String returnItemCollectionMetrics)
Whether to return the item collection metrics.DeleteItemEnhancedRequest.Builder
returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Whether to return the item collection metrics.DeleteItemEnhancedRequest.Builder
returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.DeleteItemEnhancedRequest.Builder
returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
-
-
Method Detail
-
key
public DeleteItemEnhancedRequest.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 DeleteItemEnhancedRequest.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 DeleteItemEnhancedRequest.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
-
returnConsumedCapacity
public DeleteItemEnhancedRequest.Builder returnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
Whether to return the capacity consumed by this operation.
-
returnConsumedCapacity
public DeleteItemEnhancedRequest.Builder returnConsumedCapacity(String returnConsumedCapacity)
Whether to return the capacity consumed by this operation.
-
returnItemCollectionMetrics
public DeleteItemEnhancedRequest.Builder returnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)
Whether to return the item collection metrics.
-
returnItemCollectionMetrics
public DeleteItemEnhancedRequest.Builder returnItemCollectionMetrics(String returnItemCollectionMetrics)
Whether to return the item collection metrics.
-
returnValuesOnConditionCheckFailure
public DeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
returnValuesOnConditionCheckFailure
public DeleteItemEnhancedRequest.Builder returnValuesOnConditionCheckFailure(String returnValuesOnConditionCheckFailure)
Whether to return the item on condition check failure.
-
build
public DeleteItemEnhancedRequest build()
-
-