software.amazon.awssdk.enhanced.dynamodb.model

Class DeleteItemEnhancedRequest

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest

public final class DeleteItemEnhancedRequest
extends Object

Defines parameters used to remove an item from a DynamoDb table using the deleteItem() operation (such as DynamoDbTable.deleteItem(DeleteItemEnhancedRequest) or DynamoDbAsyncTable.deleteItem(DeleteItemEnhancedRequest)).

A valid request object must contain a primary Key to reference the item to delete.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteItemEnhancedRequest.Builder A builder that is used to create a request with the desired parameters.

Method Summary

Modifier and Type	Method and Description
static DeleteItemEnhancedRequest.Builder	builder() Creates a newly initialized builder for a request object.
Expression	conditionExpression() Returns the condition Expression set on this request object, or null if it doesn't exist.
boolean	equals(Object o)
int	hashCode()
Key	key() Returns the primary Key for the item to delete.
ReturnConsumedCapacity	returnConsumedCapacity() Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString() Whether to return the capacity consumed by this operation.
ReturnItemCollectionMetrics	returnItemCollectionMetrics() Whether to return the item collection metrics.
String	returnItemCollectionMetricsAsString() Whether to return the item collection metrics.
DeleteItemEnhancedRequest.Builder	toBuilder() Returns a builder initialized with all existing values on the request object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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.

key

public Key key()

Returns the primary Key for the item to delete.

conditionExpression

public Expression conditionExpression()

Returns the condition Expression set 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 in ReturnConsumedCapacity.

returnItemCollectionMetrics

public ReturnItemCollectionMetrics returnItemCollectionMetrics()

Whether to return the item collection metrics.

See Also:

DeleteItemRequest.returnItemCollectionMetrics()

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 in ReturnItemCollectionMetrics.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object