Interface GetItemRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetItemRequest.Builder,
,GetItemRequest> DynamoDbRequest.Builder
,SdkBuilder<GetItemRequest.Builder,
,GetItemRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetItemRequest
-
Method Summary
Modifier and TypeMethodDescriptionattributesToGet
(String... attributesToGet) This is a legacy parameter.attributesToGet
(Collection<String> attributesToGet) This is a legacy parameter.consistentRead
(Boolean consistentRead) Determines the read consistency model: If set totrue
, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.expressionAttributeNames
(Map<String, String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.key
(Map<String, AttributeValue> key) A map of attribute names toAttributeValue
objects, representing the primary key of the item to retrieve.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.projectionExpression
(String projectionExpression) A string that identifies one or more attributes to retrieve from the table.returnConsumedCapacity
(String returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.returnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) Sets the value of the ReturnConsumedCapacity property for this object.The name of the table containing the requested item.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
tableName
The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
- Parameters:
tableName
- The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
key
- A map of attribute names toAttributeValue
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributesToGet
This is a legacy parameter. Use
ProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.- Parameters:
attributesToGet
- This is a legacy parameter. UseProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributesToGet
This is a legacy parameter. Use
ProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.- Parameters:
attributesToGet
- This is a legacy parameter. UseProjectionExpression
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consistentRead
Determines the read consistency model: If set to
true
, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.- Parameters:
consistentRead
- Determines the read consistency model: If set totrue
, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
returnConsumedCapacity
Sets the value of the ReturnConsumedCapacity property for this object.- Parameters:
returnConsumedCapacity
- The new value for the ReturnConsumedCapacity property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
returnConsumedCapacity
Sets the value of the ReturnConsumedCapacity property for this object.- Parameters:
returnConsumedCapacity
- The new value for the ReturnConsumedCapacity property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
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 are returned. If any of the requested attributes are not found, they do not appear in the result.
For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for usingExpressionAttributeNames
:-
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 Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-