@Generated(value="software.amazon.awssdk:codegen") public class ListImagePipelineImagesPublisher extends Object implements SdkPublisher<ListImagePipelineImagesResponse>
Represents the output for the
ImagebuilderAsyncClient.listImagePipelineImagesPaginator(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest)
operation which is a paginated operation. This class is a type of Publisher which can be
used to provide a sequence of
ListImagePipelineImagesResponse response pages as per
demand from the subscriber.
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. If there are errors in your request, you will see the failures
only after you start streaming the data. The subscribe method should be called as a request to start streaming data.
For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the
subscribe method will result in a new Subscription i.e., a new contract to stream data
from the starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.imagebuilder.paginators.ListImagePipelineImagesPublisher publisher = client.listImagePipelineImagesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
#listImagePipelineImages(software.amazon.awssdk.services.imagebuilder.model.ListImagePipelineImagesRequest)
operation.
| Constructor and Description |
|---|
ListImagePipelineImagesPublisher(ImagebuilderAsyncClient client,
ListImagePipelineImagesRequest firstRequest) |
| Modifier and Type | Method and Description |
|---|---|
void |
subscribe(org.reactivestreams.Subscriber<? super ListImagePipelineImagesResponse> subscriber) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadapt, buffer, filter, filter, flatMapIterable, limit, map, subscribepublic ListImagePipelineImagesPublisher(ImagebuilderAsyncClient client, ListImagePipelineImagesRequest firstRequest)
public void subscribe(org.reactivestreams.Subscriber<? super ListImagePipelineImagesResponse> subscriber)
subscribe in interface org.reactivestreams.Publisher<ListImagePipelineImagesResponse>Copyright © 2020. All rights reserved.