com.amazonaws.services.dynamodbv2.model

Class BatchGetItemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class BatchGetItemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a BatchGetItem operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
BatchGetItemRequest() Default constructor for BatchGetItemRequest object.
BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems) Constructs a new BatchGetItemRequest object.
BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems, ReturnConsumedCapacity returnConsumedCapacity) Constructs a new BatchGetItemRequest object.
BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems, String returnConsumedCapacity) Constructs a new BatchGetItemRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
BatchGetItemRequest	addRequestItemsEntry(String key, KeysAndAttributes value)
BatchGetItemRequest	clearRequestItemsEntries() Removes all the entries added into RequestItems.
BatchGetItemRequest	clone()
boolean	equals(Object obj)
Map<String,KeysAndAttributes>	getRequestItems() 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.
String	getReturnConsumedCapacity()
int	hashCode()
void	setRequestItems(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.
void	setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
void	setReturnConsumedCapacity(String returnConsumedCapacity)
String	toString() Returns a string representation of this object; useful for testing and debugging.
BatchGetItemRequest	withRequestItems(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.
BatchGetItemRequest	withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
BatchGetItemRequest	withReturnConsumedCapacity(String returnConsumedCapacity)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchGetItemRequest

public BatchGetItemRequest()

Default constructor for BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

BatchGetItemRequest

public BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems)

Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

BatchGetItemRequest

public BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems,
                   String returnConsumedCapacity)

Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

returnConsumedCapacity -

BatchGetItemRequest

public BatchGetItemRequest(Map<String,KeysAndAttributes> requestItems,
                   ReturnConsumedCapacity returnConsumedCapacity)

Constructs a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

returnConsumedCapacity -

Method Detail

getRequestItems

public Map<String,KeysAndAttributes> getRequestItems()

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

setRequestItems

public void setRequestItems(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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

Parameters:

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

withRequestItems

public BatchGetItemRequest withRequestItems(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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

Parameters:

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 on 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 hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

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

• AttributesToGet -

  This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

  This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

  The names of one or more attributes to retrieve. If no attribute names are provided, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

  Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

Returns:

Returns a reference to this object so that method calls can be chained together.

addRequestItemsEntry

public BatchGetItemRequest addRequestItemsEntry(String key,
                                       KeysAndAttributes value)

clearRequestItemsEntries

public BatchGetItemRequest clearRequestItemsEntries()

Removes all the entries added into RequestItems. <p> Returns a reference to this object so that method calls can be chained together.

setReturnConsumedCapacity

public void setReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

See Also:

ReturnConsumedCapacity

getReturnConsumedCapacity

public String getReturnConsumedCapacity()

Returns:

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchGetItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

setReturnConsumedCapacity

public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

See Also:

ReturnConsumedCapacity

withReturnConsumedCapacity

public BatchGetItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)

Parameters:

returnConsumedCapacity -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReturnConsumedCapacity

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BatchGetItemRequest clone()

Overrides:

clone in class AmazonWebServiceRequest