@Generated(value="software.amazon.awssdk:codegen") public class DescribeTapeArchivesPublisher extends Object implements SdkPublisher<DescribeTapeArchivesResponse>
Represents the output for the
StorageGatewayAsyncClient.describeTapeArchivesPaginator(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation which is a paginated operation. This class is a type of Publisher
which can be
used to provide a sequence of
DescribeTapeArchivesResponse
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 forEach helper method
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.storagegateway.paginators.DescribeTapeArchivesPublisher publisher = client.describeTapeArchivesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
#describeTapeArchives(software.amazon.awssdk.services.storagegateway.model.DescribeTapeArchivesRequest)
operation.
Constructor and Description |
---|
DescribeTapeArchivesPublisher(StorageGatewayAsyncClient client,
DescribeTapeArchivesRequest firstRequest) |
Modifier and Type | Method and Description |
---|---|
DescribeTapeArchivesPublisher |
resume(DescribeTapeArchivesResponse lastSuccessfulPage)
A helper method to resume the pages in case of unexpected failures.
|
void |
subscribe(org.reactivestreams.Subscriber<? super DescribeTapeArchivesResponse> subscriber) |
SdkPublisher<TapeArchive> |
tapeArchives()
Returns a publisher that can be used to get a stream of data.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach
public DescribeTapeArchivesPublisher(StorageGatewayAsyncClient client, DescribeTapeArchivesRequest firstRequest)
public void subscribe(org.reactivestreams.Subscriber<? super DescribeTapeArchivesResponse> subscriber)
subscribe
in interface org.reactivestreams.Publisher<DescribeTapeArchivesResponse>
public final SdkPublisher<TapeArchive> tapeArchives()
Consumer
and then applies that consumer to each response returned by the service.public final DescribeTapeArchivesPublisher resume(DescribeTapeArchivesResponse 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 DescribeTapeArchivesPublisher
that can be used to retrieve the
consecutive pages that follows the input page.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.