Class DeleteItemEnhancedRequest
- java.lang.Object
-
- software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest
-
@ThreadSafe public final class DeleteItemEnhancedRequest extends Object
Defines parameters used to remove an item from a DynamoDb table using the deleteItem() operation (such asDynamoDbTable.deleteItem(DeleteItemEnhancedRequest)orDynamoDbAsyncTable.deleteItem(DeleteItemEnhancedRequest)).A valid request object must contain a primary
Keyto reference the item to delete.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDeleteItemEnhancedRequest.BuilderA builder that is used to create a request with the desired parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DeleteItemEnhancedRequest.Builderbuilder()Creates a newly initialized builder for a request object.ExpressionconditionExpression()Returns the conditionExpressionset on this request object, or null if it doesn't exist.booleanequals(Object o)inthashCode()Keykey()Returns the primaryKeyfor the item to delete.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.ReturnValuesOnConditionCheckFailurereturnValuesOnConditionCheckFailure()Whether to return the item on condition check failure.StringreturnValuesOnConditionCheckFailureAsString()Whether to return the item on condition check failure.DeleteItemEnhancedRequest.BuildertoBuilder()Returns a builder initialized with all existing values on the request object.
-
-
-
Method Detail
-
builder
public static DeleteItemEnhancedRequest.Builder builder()
Creates a newly initialized builder for a request object.
-
toBuilder
public DeleteItemEnhancedRequest.Builder toBuilder()
Returns a builder initialized with all existing values on the request object.
-
conditionExpression
public Expression conditionExpression()
Returns the conditionExpressionset on this request object, or null if it doesn't exist.
-
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.
-
-