@Generated(value="software.amazon.awssdk:codegen") public class DescribeOptOutListsIterable extends Object implements SdkIterable<DescribeOptOutListsResponse>
Represents the output for the
PinpointSmsVoiceV2Client.describeOptOutListsPaginator(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation which is a paginated operation. This class is an iterable of
DescribeOptOutListsResponse 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.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client
.describeOptOutListsPaginator(request);
for (software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.pinpointsmsvoicev2.paginators.DescribeOptOutListsIterable responses = client.describeOptOutListsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
#describeOptOutLists(software.amazon.awssdk.services.pinpointsmsvoicev2.model.DescribeOptOutListsRequest)
operation.
| Constructor and Description |
|---|
DescribeOptOutListsIterable(PinpointSmsVoiceV2Client client,
DescribeOptOutListsRequest firstRequest) |
| Modifier and Type | Method and Description |
|---|---|
Iterator<DescribeOptOutListsResponse> |
iterator() |
SdkIterable<OptOutListInformation> |
optOutLists()
Returns an iterable to iterate through the paginated
DescribeOptOutListsResponse.optOutLists() member. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitstreamforEach, spliteratorpublic DescribeOptOutListsIterable(PinpointSmsVoiceV2Client client, DescribeOptOutListsRequest firstRequest)
public Iterator<DescribeOptOutListsResponse> iterator()
iterator in interface Iterable<DescribeOptOutListsResponse>public final SdkIterable<OptOutListInformation> optOutLists()
DescribeOptOutListsResponse.optOutLists() member.
The returned iterable is used to iterate through the results across all response pages and not a single page.
This method is useful if you are interested in iterating over the paginated member in the response pages instead
of the top level pages. Similar to iteration over pages, this method internally makes service calls to get the
next list of results until the iteration stops or there are no more results.Copyright © 2022. All rights reserved.