@Generated(value="software.amazon.awssdk:codegen") public final class GetItemRequest extends DynamoDbRequest implements ToCopyableBuilder<GetItemRequest.Builder,GetItemRequest>
Represents the input of a GetItem
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
GetItemRequest.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
attributesToGet()
This is a legacy parameter.
|
static GetItemRequest.Builder |
builder() |
Boolean |
consistentRead()
Determines the read consistency model: If set to
true , then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads. |
boolean |
equals(Object obj) |
Map<String,String> |
expressionAttributeNames()
One or more substitution tokens for attribute names in an expression.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Map<String,AttributeValue> |
key()
A map of attribute names to
AttributeValue objects, representing the primary key of the item to
retrieve. |
String |
projectionExpression()
A string that identifies one or more attributes to retrieve from the table.
|
ReturnConsumedCapacity |
returnConsumedCapacity()
Returns the value of the ReturnConsumedCapacity property for this object.
|
String |
returnConsumedCapacityAsString()
Returns the value of the ReturnConsumedCapacity property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetItemRequest.Builder> |
serializableBuilderClass() |
String |
tableName()
The name of the table containing the requested item.
|
GetItemRequest.Builder |
toBuilder() |
String |
toString() |
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public String tableName()
The name of the table containing the requested item.
public Map<String,AttributeValue> key()
A map of attribute names to AttributeValue
objects, representing the primary key of the item to
retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
AttributeValue
objects, representing the primary key of the item
to retrieve.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
public List<String> attributesToGet()
This is a legacy parameter. Use ProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.public Boolean consistentRead()
Determines the read consistency model: If set to true
, then the operation uses strongly consistent
reads; otherwise, the operation uses eventually consistent reads.
true
, then the operation uses strongly
consistent reads; otherwise, the operation uses eventually consistent reads.public ReturnConsumedCapacity returnConsumedCapacity()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public String returnConsumedCapacityAsString()
If the service returns an enum value that is not available in the current SDK version,
returnConsumedCapacity
will return ReturnConsumedCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from returnConsumedCapacityAsString()
.
ReturnConsumedCapacity
public String projectionExpression()
A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public Map<String,String> expressionAttributeNames()
One or more substitution tokens for attribute names in an expression. The following are some use cases for using
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
the complete list of reserved words, see Reserved Words in
the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
ExpressionAttributeNames
:
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an
expression. (For the complete list of reserved words, see Reserved
Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the
following for ExpressionAttributeNames
:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
public GetItemRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetItemRequest.Builder,GetItemRequest>
toBuilder
in class DynamoDbRequest
public static GetItemRequest.Builder builder()
public static Class<? extends GetItemRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2018. All rights reserved.