Package software.amazon.awssdk.services.ssmcontacts.paginators

Class ListPagesByEngagementIterable

  • All Implemented Interfaces:
    Iterable<ListPagesByEngagementResponse>, SdkIterable<ListPagesByEngagementResponse>
    @Generated("software.amazon.awssdk:codegen")
public class ListPagesByEngagementIterable
extends Object
implements SdkIterable<ListPagesByEngagementResponse>

    Represents the output for the SsmContactsClient.listPagesByEngagementPaginator(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation which is a paginated operation. This class is an iterable of ListPagesByEngagementResponse 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.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request);
 responses.stream().forEach(....);
    2) Using For loop 
     {
     @code
     software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client
             .listPagesByEngagementPaginator(request);
     for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response : responses) {
         // do something;
     }
 }
    3) Use iterator directly 
     
 software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(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 #listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest) operation.