Class DescribeImageReferencesIterable
- All Implemented Interfaces:
Iterable<DescribeImageReferencesResponse>,SdkIterable<DescribeImageReferencesResponse>
Represents the output for the
Ec2Client.describeImageReferencesPaginator(software.amazon.awssdk.services.ec2.model.DescribeImageReferencesRequest)
operation which is a paginated operation. This class is an iterable of
DescribeImageReferencesResponse 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.ec2.paginators.DescribeImageReferencesIterable responses = client.describeImageReferencesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ec2.paginators.DescribeImageReferencesIterable responses = client
.describeImageReferencesPaginator(request);
for (software.amazon.awssdk.services.ec2.model.DescribeImageReferencesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ec2.paginators.DescribeImageReferencesIterable responses = client.describeImageReferencesPaginator(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
invalid reference
#describeImageReferences(software.amazon.awssdk.services.ec2.model.DescribeImageReferencesRequest)
-
Constructor Summary
ConstructorsConstructorDescriptionDescribeImageReferencesIterable(Ec2Client client, DescribeImageReferencesRequest firstRequest) -
Method Summary
Modifier and TypeMethodDescriptionfinal SdkIterable<ImageReference> Returns an iterable to iterate through the paginatedDescribeImageReferencesResponse.imageReferences()member.iterator()Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface software.amazon.awssdk.core.pagination.sync.SdkIterable
stream
-
Constructor Details
-
DescribeImageReferencesIterable
public DescribeImageReferencesIterable(Ec2Client client, DescribeImageReferencesRequest firstRequest)
-
-
Method Details
-
iterator
- Specified by:
iteratorin interfaceIterable<DescribeImageReferencesResponse>
-
imageReferences
Returns an iterable to iterate through the paginatedDescribeImageReferencesResponse.imageReferences()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.
-