SearchPagedFlux Class

Package:

com.azure.search.documents.util

Maven Artifact:

com.azure:azure-search-documents:11.7.4

• java.lang.Object
• • reactor.core.publisher.Flux
  • • com.azure.core.util.paging.ContinuablePagedFlux<C,T,P>
    • • com.azure.core.util.paging.ContinuablePagedFluxCore<C,T,P>
      • • com.azure.core.http.rest.PagedFluxBase<T,P>
        • • com.azure.search.documents.util.SearchPagedFlux

public final class SearchPagedFlux
extends 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

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 and Description
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<SemanticSearchResults>	getSemanticResults() The semantic search 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 PagedFluxBase

byPage byPage com.azure.core.http.rest.PagedFluxBase.subscribe(reactor.core.CoreSubscriber<

Methods inherited from ContinuablePagedFlux

getContinuationPredicate

Methods inherited from ContinuablePagedFluxCore

byPage byPage byPage getPageSize

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 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

SearchPagedFlux

public SearchPagedFlux(Supplier> firstPageRetriever)

Creates an instance of SearchPagedFlux.

Parameters:

firstPageRetriever - Supplied that handles retrieving SearchPagedResponse.

SearchPagedFlux

public SearchPagedFlux(Supplier> firstPageRetriever, Function> nextPageRetriever)

Creates an instance of SearchPagedFlux.

Parameters:

firstPageRetriever - Supplied that handles retrieving SearchPagedResponse.

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

Method Details

getCoverage

public Mono 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>> 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.

getSemanticResults

public Mono getSemanticResults()

The semantic search results based on the search request.

If semantic search wasn't requested this will return a SemanticSearchResults with no values.

Returns:

The semantic search results if semantic search was requested, otherwise an empty SemanticSearchResults.

getTotalCount

public Mono 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.