com.amazonaws.services.dynamodbv2.document.api

Interface BatchGetItemApi

All Known Implementing Classes:

BatchGetItemImpl, DynamoDB

@ThreadSafe
public interface BatchGetItemApi

DynamoDB BatchGetItem API that can be used to retrieve multiple items from multiple tables in one request/response by specifying one or multiple primary keys per table in the request.

Method Summary

Modifier and Type	Method and Description
BatchGetItemOutcome	batchGetItem(BatchGetItemSpec spec) Used to perform a batch get-item operation from DynamoDB with full parameter specification.
BatchGetItemOutcome	batchGetItem(ReturnConsumedCapacity returnConsumedCapacity, TableKeysAndAttributes... tableKeyAndAttributes) Used to perform a batch get-item operation from DynamoDB.
BatchGetItemOutcome	batchGetItem(TableKeysAndAttributes... tableKeyAndAttributes) Used to perform a batch get-item operation from DynamoDB.
BatchGetItemOutcome	batchGetItemUnprocessed(Map<String,KeysAndAttributes> unprocessedKeys) Used to perform a batch get-item for the unprocessed keys returned from a previous batch get-item operation.
BatchGetItemOutcome	batchGetItemUnprocessed(ReturnConsumedCapacity returnConsumedCapacity, Map<String,KeysAndAttributes> unprocessedKeys) Used to perform a batch get-item for the unprocessed keys returned from a previous batch get-item operation.

Method Detail

batchGetItem

BatchGetItemOutcome batchGetItem(ReturnConsumedCapacity returnConsumedCapacity,
                                 TableKeysAndAttributes... tableKeyAndAttributes)

Used to perform a batch get-item operation from DynamoDB.

Parameters:

returnConsumedCapacity - returned capacity to be returned

tableKeyAndAttributes - the tables, keys, and attributes specification to be used to retrieve the items.

batchGetItem

BatchGetItemOutcome batchGetItem(TableKeysAndAttributes... tableKeyAndAttributes)

Used to perform a batch get-item operation from DynamoDB.

Parameters:

tableKeyAndAttributes - the tables, keys, and attributes specification to be used to retrieve the items.

batchGetItem

BatchGetItemOutcome batchGetItem(BatchGetItemSpec spec)

Used to perform a batch get-item operation from DynamoDB with full parameter specification.

batchGetItemUnprocessed

BatchGetItemOutcome batchGetItemUnprocessed(ReturnConsumedCapacity returnConsumedCapacity,
                                            Map<String,KeysAndAttributes> unprocessedKeys)

Used to perform a batch get-item for the unprocessed keys returned from a previous batch get-item operation.

Parameters:

returnConsumedCapacity - returned capacity to be returned

unprocessedKeys - the unprocessed keys returned from the result of a previous batch-get-item operation.

See Also:

BatchGetItemOutcome.getUnprocessedKeys()

batchGetItemUnprocessed

BatchGetItemOutcome batchGetItemUnprocessed(Map<String,KeysAndAttributes> unprocessedKeys)

Used to perform a batch get-item for the unprocessed keys returned from a previous batch get-item operation.

Parameters:

unprocessedKeys - the unprocessed keys returned from the result of a previous batch-get-item operation.

See Also:

BatchGetItemOutcome.getUnprocessedKeys()