software.amazon.awssdk.services.dynamodb.model

Class BatchGetItemRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dynamodb.model.DynamoDbRequest

software.amazon.awssdk.services.dynamodb.model.BatchGetItemRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetItemRequest.Builder,BatchGetItemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchGetItemRequest
extends DynamoDbRequest
implements ToCopyableBuilder<BatchGetItemRequest.Builder,BatchGetItemRequest>

Represents the input of a BatchGetItem operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchGetItemRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchGetItemRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequestItems() Returns true if the RequestItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,KeysAndAttributes>	requestItems() A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that 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 BatchGetItemRequest.Builder>	serializableBuilderClass()
BatchGetItemRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasRequestItems

public final boolean hasRequestItems()

Returns true if the RequestItems property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

requestItems

public final Map<String,KeysAndAttributes> requestItems()

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

• ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

• ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

• Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

• 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

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

You can use hasRequestItems() to see if a value was sent in this field.

Returns:

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

• ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

• ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. 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 about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

• Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

• 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 Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

• AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity

public final ReturnConsumedCapacity returnConsumedCapacity()

Returns the value of the ReturnConsumedCapacity property for this object.

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().

Returns:

The value of the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

returnConsumedCapacityAsString

public final String returnConsumedCapacityAsString()

Returns the value of the ReturnConsumedCapacity property for this object.

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().

Returns:

The value of the ReturnConsumedCapacity property for this object.

See Also:

ReturnConsumedCapacity

toBuilder

public BatchGetItemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetItemRequest.Builder,BatchGetItemRequest>

Specified by:

toBuilder in class DynamoDbRequest

builder

public static BatchGetItemRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetItemRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo