@Generated(value="software.amazon.awssdk:codegen") public class GetParametersByPathIterable extends Object implements SdkIterable<GetParametersByPathResponse>
Represents the output for the
SSMClient.getParametersByPathPaginator(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation which is a paginated operation. This class is an iterable of
GetParametersByPathResponse
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.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client .getParametersByPathPaginator(request); for (software.amazon.awssdk.services.ssm.model.GetParametersByPathResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ssm.paginators.GetParametersByPathIterable responses = client.getParametersByPathPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
#getParametersByPath(software.amazon.awssdk.services.ssm.model.GetParametersByPathRequest)
operation.
Constructor and Description |
---|
GetParametersByPathIterable(SSMClient client,
GetParametersByPathRequest firstRequest) |
Modifier and Type | Method and Description |
---|---|
Iterator<GetParametersByPathResponse> |
iterator() |
GetParametersByPathIterable |
resume(GetParametersByPathResponse lastSuccessfulPage)
A helper method to resume the pages in case of unexpected failures.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
stream
forEach, spliterator
public GetParametersByPathIterable(SSMClient client, GetParametersByPathRequest firstRequest)
public Iterator<GetParametersByPathResponse> iterator()
iterator
in interface Iterable<GetParametersByPathResponse>
public final GetParametersByPathIterable resume(GetParametersByPathResponse 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 GetParametersByPathIterable
that can be used to retrieve the
consecutive pages that follows the input page.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.