@Generated(value="software.amazon.awssdk:codegen") public class DescribeCanariesPublisher extends Object implements SdkPublisher<DescribeCanariesResponse>
Represents the output for the
SyntheticsAsyncClient.describeCanariesPaginator(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest)
operation which is a paginated operation. This class is a type of Publisher which can be
used to provide a sequence of DescribeCanariesResponse
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.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.synthetics.paginators.DescribeCanariesPublisher publisher = client.describeCanariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.synthetics.model.DescribeCanariesResponse 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
#describeCanaries(software.amazon.awssdk.services.synthetics.model.DescribeCanariesRequest) operation.
| Constructor and Description |
|---|
DescribeCanariesPublisher(SyntheticsAsyncClient client,
DescribeCanariesRequest firstRequest) |
| Modifier and Type | Method and Description |
|---|---|
void |
subscribe(org.reactivestreams.Subscriber<? super DescribeCanariesResponse> subscriber) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadapt, buffer, filter, filter, flatMapIterable, limit, map, subscribepublic DescribeCanariesPublisher(SyntheticsAsyncClient client, DescribeCanariesRequest firstRequest)
public void subscribe(org.reactivestreams.Subscriber<? super DescribeCanariesResponse> subscriber)
subscribe in interface org.reactivestreams.Publisher<DescribeCanariesResponse>Copyright © 2021. All rights reserved.