BatchGetItemRequest (AWS SDK For Java for OSGi 1.9.19 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest

All Implemented Interfaces:

Serializable
```
public class BatchGetItemRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the BatchGetItem operation.
The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys . You can use this value to retry the operation starting with the next item to get.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException . If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys .

IMPORTANT: If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed. For more information, go to Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide .

See Also:
AmazonDynamoDB.batchGetItem(BatchGetItemRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`BatchGetItemRequest()` Default constructor for a new 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)` A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve.
`BatchGetItemRequest`	`clearRequestItemsEntries()` Removes all the entries added into RequestItems.
`boolean`	`equals(Object obj)`
`Map<String,KeysAndAttributes>`	`getRequestItems()` A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve.
`String`	`getReturnConsumedCapacity()` A value that if set to `TOTAL`, the response includes ConsumedCapacity data for tables and indexes.
`int`	`hashCode()`
`void`	`setRequestItems(Map<String,KeysAndAttributes> requestItems)` A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve.
`void`	`setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)` A value that if set to `TOTAL`, the response includes ConsumedCapacity data for tables and indexes.
`void`	`setReturnConsumedCapacity(String returnConsumedCapacity)` A value that if set to `TOTAL`, the response includes ConsumedCapacity data for tables and indexes.
`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, the corresponding primary keys for the items to retrieve.
`BatchGetItemRequest`	`withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)` A value that if set to `TOTAL`, the response includes ConsumedCapacity data for tables and indexes.
`BatchGetItemRequest`	`withReturnConsumedCapacity(String returnConsumedCapacity)` A value that if set to `TOTAL`, the response includes ConsumedCapacity data for tables and indexes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BatchGetItemRequest
```
public BatchGetItemRequest()
```
    Default constructor for a new BatchGetItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this 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, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
  - 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, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
  - 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, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
- Method Detail
  - getRequestItems
```
public Map<String,KeysAndAttributes> getRequestItems()
```
    A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    - 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.
    - AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    - ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    Constraints:
    Length: 1 - 100
    Returns:
    A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
  - setRequestItems
```
public void setRequestItems(Map<String,KeysAndAttributes> requestItems)
```
    A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    - 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.
    - AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    - ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    Constraints:
    Length: 1 - 100
    Parameters:
    requestItems - A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
  - withRequestItems
```
public BatchGetItemRequest withRequestItems(Map<String,KeysAndAttributes> requestItems)
```
    A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    - 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.
    - AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    - ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    Parameters:
    requestItems - A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    
    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.
    
    AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    
    ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - addRequestItemsEntry
```
public BatchGetItemRequest addRequestItemsEntry(String key,
                                       KeysAndAttributes value)
```
    A map of one or more table names and, for each table, the corresponding primary keys for the items to retrieve. Each table name can be invoked only once.
    Each element in the map consists of the following:
    - 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.
    - AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does 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.
    - ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.
    The method adds a new key-value pair into RequestItems parameter, and returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 100
    Parameters:
    key - The key of the entry to be added into RequestItems.
    value - The corresponding value of the entry to be added into RequestItems.
  - clearRequestItemsEntries
```
public BatchGetItemRequest clearRequestItemsEntries()
```
    Removes all the entries added into RequestItems.
    Returns a reference to this object so that method calls can be chained together.
  - getReturnConsumedCapacity
```
public String getReturnConsumedCapacity()
```
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    
    Returns:
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    See Also:
    ReturnConsumedCapacity
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(String returnConsumedCapacity)
```
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    
    Parameters:
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    See Also:
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public BatchGetItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
```
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    
    Parameters:
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    ReturnConsumedCapacity
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    
    Parameters:
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    See Also:
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public BatchGetItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INDEXES, TOTAL, NONE
    
    Parameters:
    returnConsumedCapacity - A value that if set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.
    
    Returns:
    A reference to this updated 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()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class BatchGetItemRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

BatchGetItemRequest

BatchGetItemRequest

BatchGetItemRequest

BatchGetItemRequest

Method Detail

getRequestItems

setRequestItems

withRequestItems

addRequestItemsEntry

clearRequestItemsEntries

getReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

toString

hashCode

equals