@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(....);
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
#describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest) operation.
| Constructor and Description |
|---|
DescribeClustersIterable(CloudHsmV2Client client,
DescribeClustersRequest firstRequest) |
| Modifier and Type | Method and Description |
|---|---|
Iterator<DescribeClustersResponse> |
iterator() |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitstreamforEach, spliteratorpublic DescribeClustersIterable(CloudHsmV2Client client, DescribeClustersRequest firstRequest)
public Iterator<DescribeClustersResponse> iterator()
iterator in interface Iterable<DescribeClustersResponse>