Class DescribeInstanceStatusPublisher
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.paginators.DescribeInstanceStatusPublisher
-
- All Implemented Interfaces:
org.reactivestreams.Publisher<DescribeInstanceStatusResponse>
,SdkPublisher<DescribeInstanceStatusResponse>
@Generated("software.amazon.awssdk:codegen") public class DescribeInstanceStatusPublisher extends Object implements SdkPublisher<DescribeInstanceStatusResponse>
Represents the output for the
Ec2AsyncClient.describeInstanceStatusPaginator(software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusRequest)
operation which is a paginated operation. This class is a type ofPublisher
which can be used to provide a sequence ofDescribeInstanceStatusResponse
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 newSubscription
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 methodsoftware.amazon.awssdk.services.ec2.paginators.DescribeInstanceStatusPublisher publisher = client.describeInstanceStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ec2.paginators.DescribeInstanceStatusPublisher publisher = client.describeInstanceStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusResponse response) { //... }; });
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
#describeInstanceStatus(software.amazon.awssdk.services.ec2.model.DescribeInstanceStatusRequest)
operation.
-
-
Constructor Summary
Constructors Constructor Description DescribeInstanceStatusPublisher(Ec2AsyncClient client, DescribeInstanceStatusRequest firstRequest)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SdkPublisher<InstanceStatus>
instanceStatuses()
Returns a publisher that can be used to get a stream of data.void
subscribe(org.reactivestreams.Subscriber<? super DescribeInstanceStatusResponse> subscriber)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, 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 Detail
-
DescribeInstanceStatusPublisher
public DescribeInstanceStatusPublisher(Ec2AsyncClient client, DescribeInstanceStatusRequest firstRequest)
-
-
Method Detail
-
subscribe
public void subscribe(org.reactivestreams.Subscriber<? super DescribeInstanceStatusResponse> subscriber)
- Specified by:
subscribe
in interfaceorg.reactivestreams.Publisher<DescribeInstanceStatusResponse>
-
instanceStatuses
public final SdkPublisher<InstanceStatus> instanceStatuses()
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.
-
-