software.amazon.awssdk.services.chimesdkmessaging.paginators

Class ListChannelBansPublisher

java.lang.Object

software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher

All Implemented Interfaces:

org.reactivestreams.Publisher<ListChannelBansResponse>, SdkPublisher<ListChannelBansResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class ListChannelBansPublisher
extends Object
implements SdkPublisher<ListChannelBansResponse>

Represents the output for the ChimeSdkMessagingAsyncClient.listChannelBansPaginator(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest) operation which is a paginated operation. This class is a type of Publisher which can be used to provide a sequence of ListChannelBansResponse 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.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
 
 

2) Using a custom subscriber

 
 software.amazon.awssdk.services.chimesdkmessaging.paginators.ListChannelBansPublisher publisher = client.listChannelBansPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansResponse 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 #listChannelBans(software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelBansRequest) operation.

Constructor Summary

Constructors

Constructor and Description
ListChannelBansPublisher(ChimeSdkMessagingAsyncClient client, ListChannelBansRequest firstRequest)

Method Summary

Modifier and Type	Method and Description
void	subscribe(org.reactivestreams.Subscriber<? super ListChannelBansResponse> 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

adapt, buffer, doAfterOnCancel, doAfterOnComplete, doAfterOnError, filter, filter, flatMapIterable, limit, map, subscribe

Constructor Detail

ListChannelBansPublisher

public ListChannelBansPublisher(ChimeSdkMessagingAsyncClient client,
                                ListChannelBansRequest firstRequest)

Method Detail

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super ListChannelBansResponse> subscriber)

Specified by:

subscribe in interface org.reactivestreams.Publisher<ListChannelBansResponse>