Class ListVolumesPublisher
- All Implemented Interfaces:
org.reactivestreams.Publisher<ListVolumesResponse>
,SdkPublisher<ListVolumesResponse>
Represents the output for the
StorageGatewayAsyncClient.listVolumesPaginator(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)
operation which is a paginated operation. This class is a type of Publisher
which can be
used to provide a sequence of ListVolumesResponse
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.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.storagegateway.paginators.ListVolumesPublisher publisher = client.listVolumesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.storagegateway.model.ListVolumesResponse 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 Limit 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
#listVolumes(software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest)
-
Constructor Summary
ConstructorDescriptionListVolumesPublisher
(StorageGatewayAsyncClient client, ListVolumesRequest firstRequest) -
Method Summary
Modifier and TypeMethodDescriptionvoid
subscribe
(org.reactivestreams.Subscriber<? super ListVolumesResponse> subscriber) final SdkPublisher
<VolumeInfo> Returns a publisher that can be used to get a stream of data.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.core.async.SdkPublisher
addTrailingData, buffer, doAfterOnCancel, doAfterOnComplete, doAfterOnError, filter, filter, flatMapIterable, limit, map, subscribe
-
Constructor Details
-
ListVolumesPublisher
-
-
Method Details
-
subscribe
- Specified by:
subscribe
in interfaceorg.reactivestreams.Publisher<ListVolumesResponse>
-
volumeInfos
Returns a publisher that can be used to get a stream of data. You need to subscribe to the publisher to request the stream of data. The publisher has a helper forEach method that takes in aConsumer
and then applies that consumer to each response returned by the service.
-