Package software.amazon.awssdk.enhanced.dynamodb.model

Class GetItemEnhancedRequest

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.GetItemEnhancedRequest

@ThreadSafe
public final class GetItemEnhancedRequest
extends Object

Defines parameters used to retrieve an item from a DynamoDb table using the getItem() operation (such as DynamoDbTable.getItem(GetItemEnhancedRequest) or DynamoDbAsyncTable.getItem(GetItemEnhancedRequest)).

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GetItemEnhancedRequest.Builder	builder()	All requests must be constructed using a Builder.
Boolean	consistentRead()
boolean	equals(Object o)
int	hashCode()
Key	key()	Returns the primary Key for the item to get.
ReturnConsumedCapacity	returnConsumedCapacity()	Whether to return the capacity consumed by this operation.
String	returnConsumedCapacityAsString()	Whether to return the capacity consumed by this operation.
GetItemEnhancedRequest.Builder	toBuilder()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static GetItemEnhancedRequest.Builder builder()

All requests must be constructed using a Builder.

Returns:

a builder of this type

toBuilder

public GetItemEnhancedRequest.Builder toBuilder()

Returns:

a builder with all existing values set

consistentRead

public Boolean consistentRead()

Returns:

whether or not this request will use consistent read

key

public Key key()

Returns the primary Key for the item to get.

returnConsumedCapacity

public ReturnConsumedCapacity returnConsumedCapacity()

Whether to return the capacity consumed by this operation.

See Also:

• GetItemRequest.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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object