@Generated(value="software.amazon.awssdk:codegen") public class ListGroupsIterable extends Object implements SdkIterable<ListGroupsResponse>
Represents the output for the
ResourceGroupsClient.listGroupsPaginator(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation which is a paginated operation. This class is an iterable of
ListGroupsResponse
that can be used to iterate through
all the response pages of the operation.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request); for (software.amazon.awssdk.services.resourcegroups.model.ListGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroups.paginators.ListGroupsIterable responses = client.listGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
#listGroups(software.amazon.awssdk.services.resourcegroups.model.ListGroupsRequest)
operation.
Constructor and Description |
---|
ListGroupsIterable(ResourceGroupsClient client,
ListGroupsRequest firstRequest) |
Modifier and Type | Method and Description |
---|---|
Iterator<ListGroupsResponse> |
iterator() |
ListGroupsIterable |
resume(ListGroupsResponse lastSuccessfulPage)
A helper method to resume the pages in case of unexpected failures.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
stream
forEach, spliterator
public ListGroupsIterable(ResourceGroupsClient client, ListGroupsRequest firstRequest)
public Iterator<ListGroupsResponse> iterator()
iterator
in interface Iterable<ListGroupsResponse>
public final ListGroupsIterable resume(ListGroupsResponse lastSuccessfulPage)
A helper method to resume the pages in case of unexpected failures. The method takes the last successful response
page as input and returns an instance of ListGroupsIterable
that can be used to retrieve the consecutive
pages that follows the input page.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.