software.amazon.awssdk.services.cloudhsmv2.paginators

Class DescribeClustersIterable

java.lang.Object

software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable

All Implemented Interfaces:

Iterable<DescribeClustersResponse>, SdkIterable<DescribeClustersResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeClustersIterable
extends Object
implements SdkIterable<DescribeClustersResponse>

Represents the output for the CloudHSMV2Client.describeClustersPaginator(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation which is a paginated operation. This class is an iterable of DescribeClustersResponse 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.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client
             .describeClustersPaginator(request);
     for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the #describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.

Constructor Summary

Constructors

Constructor and Description
DescribeClustersIterable(CloudHSMV2Client client, DescribeClustersRequest firstRequest)

Method Summary

Modifier and Type	Method and Description
Iterator<DescribeClustersResponse>	iterator()
DescribeClustersIterable	resume(DescribeClustersResponse lastSuccessfulPage) A helper method to resume the pages in case of unexpected failures.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DescribeClustersIterable

public DescribeClustersIterable(CloudHSMV2Client client,
                                DescribeClustersRequest firstRequest)

Method Detail

iterator

public Iterator<DescribeClustersResponse> iterator()

Specified by:

iterator in interface Iterable<DescribeClustersResponse>

resume

public final DescribeClustersIterable resume(DescribeClustersResponse 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 DescribeClustersIterable that can be used to retrieve the consecutive pages that follows the input page.