Package com.azure.search.documents.util

Class SearchPagedFlux

java.lang.Object

reactor.core.publisher.Flux<T>

com.azure.core.util.paging.ContinuablePagedFlux<C,T,P>

com.azure.core.util.paging.ContinuablePagedFluxCore<String,T,P>

com.azure.core.http.rest.PagedFluxBase<SearchResult,SearchPagedResponse>

com.azure.search.documents.util.SearchPagedFlux

All Implemented Interfaces:

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

public final class SearchPagedFlux
extends com.azure.core.http.rest.PagedFluxBase<SearchResult,SearchPagedResponse>

Implementation of ContinuablePagedFlux where the continuation token type is SearchRequest, the element type is SearchResult, and the page type is SearchPagedResponse.

Constructor Summary

Constructors

Constructor	Description
SearchPagedFlux(Supplier<Mono<SearchPagedResponse>> firstPageRetriever)	Creates an instance of SearchPagedFlux.
SearchPagedFlux(Supplier<Mono<SearchPagedResponse>> firstPageRetriever, Function<String,Mono<SearchPagedResponse>> nextPageRetriever)	Creates an instance of SearchPagedFlux.

Method Summary

Modifier and Type	Method	Description
Mono<List<AnswerResult>>	getAnswers()	The answer results based on the search request.
Mono<Double>	getCoverage()	The percentage of the index covered in the search request.
Mono<Map<String,List<FacetResult>>>	getFacets()	The facet query results based on the search request.
Mono<Long>	getTotalCount()	The approximate number of documents that matched the search and filter parameters in the request.

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

byPage, byPage, subscribe

Methods inherited from class com.azure.core.util.paging.ContinuablePagedFluxCore

byPage, byPage, getPageSize

Methods inherited from class com.azure.core.util.paging.ContinuablePagedFlux

getContinuationPredicate

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, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapIterable, concatMapIterable, concatWith, concatWithValues, contextWrite, contextWrite, count, create, create, defaultIfEmpty, defer, deferContextual, 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, firstWithSignal, firstWithSignal, firstWithValue, firstWithValue, 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, mapNotNull, materialize, merge, merge, merge, merge, merge, merge, mergeComparing, mergeComparing, mergeComparing, mergeComparingDelayError, mergeComparingWith, 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, 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, retryWhen, sample, sample, sampleFirst, sampleFirst, sampleTimeout, sampleTimeout, scan, scan, scanWith, share, shareNext, 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, switchOnFirst, switchOnNext, switchOnNext, tag, take, take, take, take, takeLast, takeUntil, takeUntilOther, takeWhile, then, then, thenEmpty, thenMany, timed, timed, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timestamp, timestamp, toIterable, toIterable, toIterable, toStream, toStream, toString, transform, transformDeferred, transformDeferredContextual, using, using, 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

SearchPagedFlux

public SearchPagedFlux(Supplier<Mono<SearchPagedResponse>> firstPageRetriever)

Creates an instance of SearchPagedFlux.

Parameters:

firstPageRetriever - Supplied that handles retrieving SearchPagedResponses.

SearchPagedFlux

public SearchPagedFlux(Supplier<Mono<SearchPagedResponse>> firstPageRetriever,
                       Function<String,Mono<SearchPagedResponse>> nextPageRetriever)

Creates an instance of SearchPagedFlux.

Parameters:

firstPageRetriever - Supplied that handles retrieving SearchPagedResponses.

nextPageRetriever - Function that retrieves the next SearchPagedResponses given a continuation token.

Method Detail

getTotalCount

public Mono<Long> getTotalCount()

The approximate number of documents that matched the search and filter parameters in the request.

If count is set to false in the request this will be null.

Returns:

The approximate number of documents that match the request if count is true, otherwise null.

getCoverage

public Mono<Double> getCoverage()

The percentage of the index covered in the search request.

If minimumCoverage wasn't supplied in the request this will be null.

Returns:

The percentage of the index covered in the search request if minimumCoverage was set in the request, otherwise null.

getFacets

public Mono<Map<String,List<FacetResult>>> getFacets()

The facet query results based on the search request.

If facets weren't supplied in the request this will be null.

Returns:

The facet query results if facets were supplied in the request, otherwise null.

getAnswers

public Mono<List<AnswerResult>> getAnswers()

The answer results based on the search request.

If answers wasn't supplied in the request this will be null.

Returns:

The answer results if answers were supplied in the request, otherwise null.