@Generated(value="software.amazon.awssdk:codegen") public class DescribeFolderContentsPublisher extends Object implements SdkPublisher<DescribeFolderContentsResponse>
Represents the output for the
WorkDocsAsyncClient.describeFolderContentsPaginator(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation which is a paginated operation. This class is a type of Publisher
which can be
used to provide a sequence of DescribeFolderContentsResponse
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.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workdocs.paginators.DescribeFolderContentsPublisher publisher = client.describeFolderContentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse 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
#describeFolderContents(software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsRequest)
operation.
Constructor and Description |
---|
DescribeFolderContentsPublisher(WorkDocsAsyncClient client,
DescribeFolderContentsRequest firstRequest) |
Modifier and Type | Method and Description |
---|---|
SdkPublisher<DocumentMetadata> |
documents()
Returns a publisher that can be used to get a stream of data.
|
SdkPublisher<FolderMetadata> |
folders()
Returns a publisher that can be used to get a stream of data.
|
DescribeFolderContentsPublisher |
resume(DescribeFolderContentsResponse lastSuccessfulPage)
A helper method to resume the pages in case of unexpected failures.
|
void |
subscribe(org.reactivestreams.Subscriber<? super DescribeFolderContentsResponse> subscriber) |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach
public DescribeFolderContentsPublisher(WorkDocsAsyncClient client, DescribeFolderContentsRequest firstRequest)
public void subscribe(org.reactivestreams.Subscriber<? super DescribeFolderContentsResponse> subscriber)
subscribe
in interface org.reactivestreams.Publisher<DescribeFolderContentsResponse>
public final SdkPublisher<FolderMetadata> folders()
Consumer
and then applies that consumer to each response returned by the service.public final SdkPublisher<DocumentMetadata> documents()
Consumer
and then applies that consumer to each response returned by the service.public final DescribeFolderContentsPublisher resume(DescribeFolderContentsResponse 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 DescribeFolderContentsPublisher
that can be used to retrieve the
consecutive pages that follows the input page.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.