Package software.amazon.awssdk.enhanced.dynamodb.model

Class BatchGetResultPage

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.BatchGetResultPage

@ThreadSafe
public final class BatchGetResultPage
extends Object

Defines one result page with retrieved items in the result of a batchGetItem() operation, such as DynamoDbEnhancedClient.batchGetItem(BatchGetItemEnhancedRequest).

Use the resultsForTable(MappedTableResource) method once for each table present in the request to retrieve items from that table in the page.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BatchGetResultPage.Builder	A builder that is used to create a result object with the desired parameters.

Method Summary

Modifier and Type	Method	Description
static BatchGetResultPage.Builder	builder()	Creates a newly initialized builder for a result object.
List<ConsumedCapacity>	consumedCapacity()
<T> List<T>	resultsForTable(MappedTableResource<T> mappedTable)	Retrieve all items on this result page belonging to the supplied table.
List<Key>	unprocessedKeysForTable(MappedTableResource<?> mappedTable)	Returns a list of keys associated with a given table that were not processed during the operation, typically because the total size of the request is too large or exceeds the provisioned throughput of the table.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BatchGetResultPage.Builder builder()

Creates a newly initialized builder for a result object.

resultsForTable

public <T> List<T> resultsForTable(MappedTableResource<T> mappedTable)

Retrieve all items on this result page belonging to the supplied table. Call this method once for each table present in the batch request.

Type Parameters:

T - the type of the table items

Parameters:

mappedTable - the table to retrieve items for

Returns:

a list of items

unprocessedKeysForTable

public List<Key> unprocessedKeysForTable(MappedTableResource<?> mappedTable)

Returns a list of keys associated with a given table that were not processed during the operation, typically because the total size of the request is too large or exceeds the provisioned throughput of the table. If an item was attempted to be retrieved but not found in the table, it will not appear in this list or the results list.

Parameters:

mappedTable - the table to retrieve the unprocessed keys for

Returns:

a list of unprocessed keys

consumedCapacity

public List<ConsumedCapacity> consumedCapacity()