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 asDynamoDbTable.getItem(GetItemEnhancedRequest)orDynamoDbAsyncTable.getItem(GetItemEnhancedRequest)).A valid request object must contain a primary
Keyto reference the item to get.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classGetItemEnhancedRequest.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 GetItemEnhancedRequest.Builderbuilder()All requests must be constructed using a Builder.BooleanconsistentRead()booleanequals(Object o)inthashCode()Keykey()Returns the primaryKeyfor the item to get.ReturnConsumedCapacityreturnConsumedCapacity()Whether to return the capacity consumed by this operation.StringreturnConsumedCapacityAsString()Whether to return the capacity consumed by this operation.GetItemEnhancedRequest.BuildertoBuilder()
-
-
-
Method Detail
-
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
-
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 inReturnConsumedCapacity.
-
-