Class ListPhoneNumbersOptedOutIterable
- java.lang.Object
-
- software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable
-
- All Implemented Interfaces:
Iterable<ListPhoneNumbersOptedOutResponse>
,SdkIterable<ListPhoneNumbersOptedOutResponse>
@Generated("software.amazon.awssdk:codegen") public class ListPhoneNumbersOptedOutIterable extends Object implements SdkIterable<ListPhoneNumbersOptedOutResponse>
Represents the output for the
SnsClient.listPhoneNumbersOptedOutPaginator(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation which is a paginated operation. This class is an iterable ofListPhoneNumbersOptedOutResponse
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 Streamsoftware.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client .listPhoneNumbersOptedOutPaginator(request); for (software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutIterable responses = client.listPhoneNumbersOptedOutPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null 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
#listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest)
operation.
-
-
Constructor Summary
Constructors Constructor Description ListPhoneNumbersOptedOutIterable(SnsClient client, ListPhoneNumbersOptedOutRequest firstRequest)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterator<ListPhoneNumbersOptedOutResponse>
iterator()
SdkIterable<String>
phoneNumbers()
Returns an iterable to iterate through the paginatedListPhoneNumbersOptedOutResponse.phoneNumbers()
member.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Methods inherited from interface software.amazon.awssdk.core.pagination.sync.SdkIterable
stream
-
-
-
-
Constructor Detail
-
ListPhoneNumbersOptedOutIterable
public ListPhoneNumbersOptedOutIterable(SnsClient client, ListPhoneNumbersOptedOutRequest firstRequest)
-
-
Method Detail
-
iterator
public Iterator<ListPhoneNumbersOptedOutResponse> iterator()
- Specified by:
iterator
in interfaceIterable<ListPhoneNumbersOptedOutResponse>
-
phoneNumbers
public final SdkIterable<String> phoneNumbers()
Returns an iterable to iterate through the paginatedListPhoneNumbersOptedOutResponse.phoneNumbers()
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.
-
-