ContinuablePagedFlux<C,T,P> Class

Package:

com.azure.core.util.paging

Maven Artifact:

com.azure:azure-core:1.49.0

• java.lang.Object
• • reactor.core.publisher.Flux
  • • com.azure.core.util.paging.ContinuablePagedFlux<C,T,P>

Type Parameters

C

Type of the continuation token.

T

Type of the elements in the page.

P

Type of the page.

public abstract class ContinuablePagedFlux<C,T,P>
extends Flux<T>

This class is a Flux implementation that provides the ability to operate on pages of type ContinuablePage<C,T> and individual items in such pages. This type supports user-provided continuation tokens, allowing for restarting from a previously-retrieved continuation token.

Constructor Summary

Modifier	Constructor	Description
	ContinuablePagedFlux()	Creates an instance of ContinuablePagedFlux.
protected	ContinuablePagedFlux(Predicate<C> continuationPredicate)	Creates an instance of ContinuablePagedFlux.

Method Summary

Modifier and Type	Method and Description
abstract Flux<P>	byPage() Gets a Flux of ContinuablePage<C,T> starting at the first page.
abstract Flux<P>	byPage(C continuationToken) Gets a Flux of ContinuablePage<C,T> beginning at the page identified by the given continuation token.
abstract Flux<P>	byPage(C continuationToken, int preferredPageSize) Gets a Flux of ContinuablePage<C,T> beginning at the page identified by the given continuation token requesting each page to contain the number of elements equal to the preferred page size.
abstract Flux<P>	byPage(int preferredPageSize) Gets a Flux of ContinuablePage<C,T> starting at the first page requesting each page to contain a number of elements equal to the preferred page size.
protected final Predicate<C>	getContinuationPredicate() Gets the Predicate that determines if paging should continue.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll wait wait wait

Methods inherited from reactor.core.publisher.Flux

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

Constructor Details

ContinuablePagedFlux

public ContinuablePagedFlux()

Creates an instance of ContinuablePagedFlux.

Continuation completes when the last returned continuation token is null.

ContinuablePagedFlux

protected ContinuablePagedFlux(Predicate continuationPredicate)

Creates an instance of ContinuablePagedFlux.

If continuationPredicate is null then the predicate will only check if the continuation token is non-null.

Parameters:

continuationPredicate - A predicate which determines if paging should continue.

Method Details

byPage

public abstract Flux

byPage()

Gets a Flux of ContinuablePage<C,T> starting at the first page.

Returns:

A Flux of ContinuablePage<C,T>.

byPage

public abstract Flux

byPage(C continuationToken)

Gets a Flux of ContinuablePage<C,T> beginning at the page identified by the given continuation token.

Parameters:

continuationToken - A continuation token identifying the page to select.

Returns:

A Flux of ContinuablePage<C,T>.

byPage

public abstract Flux

byPage(C continuationToken, int preferredPageSize)

Gets a Flux of ContinuablePage<C,T> beginning at the page identified by the given continuation token requesting each page to contain the number of elements equal to the preferred page size.

The service may or may not honor the preferred page size therefore the client MUST be prepared to handle pages with different page sizes.

Parameters:

continuationToken - A continuation token identifying the page to select.

preferredPageSize - The preferred page size.

Returns:

A Flux of ContinuablePage<C,T>.

byPage

public abstract Flux

byPage(int preferredPageSize)

Gets a Flux of ContinuablePage<C,T> starting at the first page requesting each page to contain a number of elements equal to the preferred page size.

The service may or may not honor the preferred page size therefore the client MUST be prepared to handle pages with different page sizes.

Parameters:

preferredPageSize - The preferred page size.

Returns:

A Flux of ContinuablePage<C,T>.

getContinuationPredicate

protected final Predicate getContinuationPredicate()

Gets the Predicate that determines if paging should continue.

Returns:

The Predicate that determines if paging should continue.