software.amazon.awssdk.enhanced.dynamodb.model

Interface BatchGetResultPageIterable

All Superinterfaces:

Iterable<BatchGetResultPage>, SdkIterable<BatchGetResultPage>

@ThreadSafe
public interface BatchGetResultPageIterable
extends SdkIterable<BatchGetResultPage>

Defines the result of DynamoDbEnhancedClient.batchGetItem(software.amazon.awssdk.enhanced.dynamodb.model.BatchGetItemEnhancedRequest) operation.

The result can be accessed either through iterable BatchGetResultPages or flattened items across all pages via resultsForTable(software.amazon.awssdk.enhanced.dynamodb.MappedTableResource<T>)

Example:

1) Iterating through pages

 
 batchResults.forEach(page -> {
     page.resultsForTable(firstItemTable).forEach(item -> System.out.println(item));
     page.resultsForTable(secondItemTable).forEach(item -> System.out.println(item));
 });
 
 

2) Iterating through items across all pages

 
 results.resultsForTable(firstItemTable).forEach(item -> System.out.println(item));
 results.resultsForTable(secondItemTable).forEach(item -> System.out.println(item));
 
 

Method Summary

Modifier and Type	Method and Description
static BatchGetResultPageIterable	create(SdkIterable<BatchGetResultPage> pageIterable)
default <T> SdkIterable<T>	resultsForTable(MappedTableResource<T> mappedTable) Retrieve all items belonging to the supplied table across all pages.

Methods inherited from interface software.amazon.awssdk.core.pagination.sync.SdkIterable

stream

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

create

static BatchGetResultPageIterable create(SdkIterable<BatchGetResultPage> pageIterable)

resultsForTable

default <T> SdkIterable<T> resultsForTable(MappedTableResource<T> mappedTable)

Retrieve all items belonging to the supplied table across all pages.

Type Parameters:

T - the type of the table items

Parameters:

mappedTable - the table to retrieve items for

Returns:

iterable items