com.azure.core.http.rest

Class PagedFlux<T>

java.lang.Object

reactor.core.publisher.Flux<T>

com.azure.core.http.rest.PagedFluxBase<T,PagedResponse<T>>

com.azure.core.http.rest.PagedFlux<T>

Type Parameters:

T - The type of items in a PagedResponse

All Implemented Interfaces:

org.reactivestreams.Publisher<T>, CorePublisher<T>

public class PagedFlux<T>
extends PagedFluxBase<T,PagedResponse<T>>

This class is a flux that can operate on a PagedResponse and also provides the ability to operate on individual items. When processing the response by page, each response will contain the items in the page as well as the request details like status code and headers.

To process one item at a time, simply subscribe to this flux as shown below

Code sample

// Subscribe to process one item at a time
pagedFlux
    .log()
    .subscribe(item -> System.out.println("Processing item " + item),
        error -> System.err.println("Error occurred " + error),
        () -> System.out.println("Completed processing."));

To process one page at a time, use PagedFluxBase.byPage() method as shown below

Code sample

// Subscribe to process one page at a time from the beginning
pagedFlux
    .byPage()
    .log()
    .subscribe(page -> System.out.println("Processing page containing " + page.getItems()),
        error -> System.err.println("Error occurred " + error),
        () -> System.out.println("Completed processing."));

To process items one page at a time starting from any page associated with a continuation token, use PagedFluxBase.byPage(String) as shown below

Code sample

// Subscribe to process one page at a time starting from a page associated with
// a continuation token
String continuationToken = getContinuationToken();
pagedFlux
    .byPage(continuationToken)
    .log()
    .doOnSubscribe(ignored -> System.out.println(
        "Subscribed to paged flux processing pages starting from: " + continuationToken))
    .subscribe(page -> System.out.println("Processing page containing " + page.getItems()),
        error -> System.err.println("Error occurred " + error),
        () -> System.out.println("Completed processing."));

See Also:

PagedResponse, Page, Flux

Constructor Summary

Constructors

Constructor and Description
PagedFlux(Supplier<Mono<PagedResponse<T>>> firstPageRetriever) Creates an instance of PagedFlux that consists of only a single page of results.
PagedFlux(Supplier<Mono<PagedResponse<T>>> firstPageRetriever, Function<String,Mono<PagedResponse<T>>> nextPageRetriever) Creates an instance of PagedFlux.

Method Summary

Modifier and Type	Method and Description
<S> PagedFlux<S>	mapPage(Function<T,S> mapper) Maps this PagedFlux instance of T to a PagedFlux instance of type S as per the provided mapper function.

Methods inherited from class com.azure.core.http.rest.PagedFluxBase

byPage, byPage, subscribe

Methods inherited from class reactor.core.publisher.Flux

all, any, as, blockFirst, blockFirst, blockLast, blockLast, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferTimeout, bufferTimeout, bufferTimeout, bufferTimeout, bufferUntil, bufferUntil, bufferUntilChanged, bufferUntilChanged, bufferUntilChanged, bufferWhen, bufferWhen, bufferWhile, cache, cache, cache, cache, cache, cache, cancelOn, cast, checkpoint, checkpoint, checkpoint, collect, collect, collectList, collectMap, collectMap, collectMap, collectMultimap, collectMultimap, collectMultimap, collectSortedList, collectSortedList, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapIterable, concatMapIterable, concatWith, concatWithValues, count, create, create, defaultIfEmpty, defer, deferWithContext, delayElements, delayElements, delaySequence, delaySequence, delaySubscription, delaySubscription, delaySubscription, delayUntil, dematerialize, distinct, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterTerminate, doFinally, doFirst, doOnCancel, doOnComplete, doOnDiscard, doOnEach, doOnError, doOnError, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elapsed, elapsed, elementAt, elementAt, empty, error, error, error, expand, expand, expandDeep, expandDeep, filter, filterWhen, filterWhen, first, first, flatMap, flatMap, flatMap, flatMap, flatMapDelayError, flatMapIterable, flatMapIterable, flatMapSequential, flatMapSequential, flatMapSequential, flatMapSequentialDelayError, from, fromArray, fromIterable, fromStream, fromStream, generate, generate, generate, getPrefetch, groupBy, groupBy, groupBy, groupBy, groupJoin, handle, hasElement, hasElements, hide, ignoreElements, index, index, interval, interval, interval, interval, join, just, just, last, last, limitRate, limitRate, limitRequest, log, log, log, log, log, log, map, materialize, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeOrdered, mergeOrdered, mergeOrdered, mergeOrderedWith, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequential, mergeSequentialDelayError, mergeSequentialDelayError, mergeSequentialDelayError, mergeWith, metrics, name, never, next, ofType, onAssembly, onAssembly, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureError, onBackpressureLatest, onErrorContinue, onErrorContinue, onErrorContinue, onErrorMap, onErrorMap, onErrorMap, onErrorResume, onErrorResume, onErrorResume, onErrorReturn, onErrorReturn, onErrorReturn, onErrorStop, onLastAssembly, onTerminateDetach, or, parallel, parallel, parallel, publish, publish, publish, publish, publishNext, publishOn, publishOn, publishOn, push, push, range, reduce, reduce, reduceWith, repeat, repeat, repeat, repeat, repeatWhen, replay, replay, replay, replay, replay, replay, retry, retry, retry, retry, retryBackoff, retryBackoff, retryBackoff, retryBackoff, retryBackoff, retryWhen, sample, sample, sampleFirst, sampleFirst, sampleTimeout, sampleTimeout, scan, scan, scanWith, share, single, single, singleOrEmpty, skip, skip, skip, skipLast, skipUntil, skipUntilOther, skipWhile, sort, sort, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeOn, subscriberContext, subscriberContext, subscribeWith, switchIfEmpty, switchMap, switchMap, switchOnFirst, switchOnNext, switchOnNext, tag, take, take, take, takeLast, takeUntil, takeUntilOther, takeWhile, then, then, thenEmpty, thenMany, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timestamp, timestamp, toIterable, toIterable, toIterable, toStream, toStream, toString, transform, transformDeferred, using, using, usingWhen, usingWhen, usingWhen, usingWhen, window, window, window, window, window, window, window, windowTimeout, windowTimeout, windowUntil, windowUntil, windowUntil, windowUntilChanged, windowUntilChanged, windowUntilChanged, windowWhen, windowWhile, windowWhile, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith, zipWith, zipWith, zipWithIterable, zipWithIterable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PagedFlux

public PagedFlux(Supplier<Mono<PagedResponse<T>>> firstPageRetriever)

Creates an instance of PagedFlux that consists of only a single page of results. The only argument to this constructor therefore is a supplier that fetches the first (and known-only) page of T.

Code sample

// A supplier that fetches the first page of data from source/service
Supplier<Mono<PagedResponse<Integer>>> firstPageRetrieverFunction = () -> getFirstPage();

PagedFlux<Integer> pagedFluxInstance = new PagedFlux<>(firstPageRetrieverFunction,
    nextPageRetriever);

Parameters:

firstPageRetriever - Supplier that retrieves the first page.

PagedFlux

public PagedFlux(Supplier<Mono<PagedResponse<T>>> firstPageRetriever,
                 Function<String,Mono<PagedResponse<T>>> nextPageRetriever)

Creates an instance of PagedFlux. The constructor takes in two arguments. The first argument is a supplier that fetches the first page of T. The second argument is a function that fetches subsequent pages of T

Code sample

// A supplier that fetches the first page of data from source/service
Supplier<Mono<PagedResponse<Integer>>> firstPageRetriever = () -> getFirstPage();

// A function that fetches subsequent pages of data from source/service given a continuation token
Function<String, Mono<PagedResponse<Integer>>> nextPageRetriever =
    continuationToken -> getNextPage(continuationToken);

PagedFlux<Integer> pagedFlux = new PagedFlux<>(firstPageRetriever,
    nextPageRetriever);

Parameters:

firstPageRetriever - Supplier that retrieves the first page

nextPageRetriever - Function that retrieves the next page given a continuation token

Method Detail

mapPage

public <S> PagedFlux<S> mapPage(Function<T,S> mapper)

Maps this PagedFlux instance of T to a PagedFlux instance of type S as per the provided mapper function.

Type Parameters:

S - The mapped type.

Parameters:

mapper - The mapper function to convert from type T to type S.

Returns:

A PagedFlux of type S.