software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher Maven / Gradle / Ivy

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.athena.paginators;

import java.util.concurrent.CompletableFuture;
import org.reactivestreams.Subscriber;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.async.SdkPublisher;
import software.amazon.awssdk.core.pagination.async.AsyncPageFetcher;
import software.amazon.awssdk.core.pagination.async.ResponsesSubscription;
import software.amazon.awssdk.core.util.PaginatorUtils;
import software.amazon.awssdk.services.athena.AthenaAsyncClient;
import software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest;
import software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse;

/**
 * 
 * Represents the output for the
 * {@link software.amazon.awssdk.services.athena.AthenaAsyncClient#listQueryExecutionsPaginator(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)}
 * operation which is a paginated operation. This class is a type of {@link org.reactivestreams.Publisher} which can be
 * used to provide a sequence of {@link software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse}
 * 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 {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the
 * subscribe method will result in a new {@link org.reactivestreams.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
 * 
 *  * {@code
 * software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 * CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
 * future.get();
 * }
 * 
 *
 * 2) Using a custom subscriber
 * 
 *  * {@code
 * software.amazon.awssdk.services.athena.paginators.ListQueryExecutionsPublisher publisher = client.listQueryExecutionsPaginator(request);
 * publisher.subscribe(new Subscriber() {
 * 
 * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 * 
 * 
 * public void onNext(software.amazon.awssdk.services.athena.model.ListQueryExecutionsResponse 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
 * {@link #listQueryExecutions(software.amazon.awssdk.services.athena.model.ListQueryExecutionsRequest)} operation.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public class ListQueryExecutionsPublisher implements SdkPublisher {
    private final AthenaAsyncClient client;

    private final ListQueryExecutionsRequest firstRequest;

    private final AsyncPageFetcher nextPageFetcher;

    private boolean isLastPage;

    public ListQueryExecutionsPublisher(AthenaAsyncClient client, ListQueryExecutionsRequest firstRequest) {
        this(client, firstRequest, false);
    }

    private ListQueryExecutionsPublisher(AthenaAsyncClient client, ListQueryExecutionsRequest firstRequest, boolean isLastPage) {
        this.client = client;
        this.firstRequest = firstRequest;
        this.isLastPage = isLastPage;
        this.nextPageFetcher = new ListQueryExecutionsResponseFetcher();
    }

    @Override
    public void subscribe(Subscriber subscriber) {
        subscriber.onSubscribe(ResponsesSubscription.builder().subscriber(subscriber).nextPageFetcher(nextPageFetcher).build());
    }

    private class ListQueryExecutionsResponseFetcher implements AsyncPageFetcher {
        @Override
        public boolean hasNextPage(final ListQueryExecutionsResponse previousPage) {
            return PaginatorUtils.isOutputTokenAvailable(previousPage.nextToken());
        }

        @Override
        public CompletableFuture nextPage(final ListQueryExecutionsResponse previousPage) {
            if (previousPage == null) {
                return client.listQueryExecutions(firstRequest);
            }
            return client.listQueryExecutions(firstRequest.toBuilder().nextToken(previousPage.nextToken()).build());
        }
    }
}