Class SearchPagedIterable

java.lang.Object

com.azure.core.util.IterableStream<SearchResult>

com.azure.core.util.paging.ContinuablePagedIterable<String, SearchResult, SearchPagedResponse>

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

com.azure.search.documents.util.SearchPagedIterable

All Implemented Interfaces:

Iterable<SearchResult>

public final class SearchPagedIterable
extends com.azure.core.http.rest.PagedIterableBase<SearchResult, SearchPagedResponse>

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

Constructor Summary

Constructors

Constructor	Description
SearchPagedIterable(SearchPagedFlux pagedFlux)	Deprecated. Use SearchPagedIterable(Supplier) or SearchPagedIterable(Supplier, Function).
SearchPagedIterable(Supplier<SearchPagedResponse> firstPageRetriever)	Creates an instance of SearchPagedIterable.
SearchPagedIterable(Supplier<SearchPagedResponse> firstPageRetriever, Function<String, SearchPagedResponse> nextPageRetriever)	Creates an instance of SearchPagedIterable.

Method Summary

Modifier and Type	Method	Description
Double	getCoverage()	Deprecated. Use SearchPagedResponse.getCoverage() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().
DebugInfo	getDebugInfo()	Deprecated. Use SearchPagedResponse.getDebugInfo() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().
Map<String, List<FacetResult>>	getFacets()	Deprecated. Use SearchPagedResponse.getFacets() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().
SemanticSearchResults	getSemanticResults()	Deprecated. Use SearchPagedResponse.getSemanticResults() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().
Long	getTotalCount()	Deprecated. Use SearchPagedResponse.getCount() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

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

iterableByPage, iterableByPage, iterableByPage, iterableByPage, iterator, stream, streamByPage, streamByPage, streamByPage, streamByPage

Methods inherited from class com.azure.core.util.IterableStream

of

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

SearchPagedIterable

@Deprecated
public SearchPagedIterable(SearchPagedFlux pagedFlux)

Deprecated.

Use SearchPagedIterable(Supplier) or SearchPagedIterable(Supplier, Function).

Creates an instance of SearchPagedIterable.

Parameters:

pagedFlux - The SearchPagedFlux that will be consumed as an iterable.

SearchPagedIterable

public SearchPagedIterable(Supplier<SearchPagedResponse> firstPageRetriever)

Creates an instance of SearchPagedIterable. The constructor takes a Supplier. The Supplier returns the first page of SearchPagedResponse.

Parameters:

firstPageRetriever - Supplier that retrieves the first page

SearchPagedIterable

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

Creates an instance of SearchPagedIterable. The constructor takes a Supplier and Function. The Supplier returns the first page of SearchPagedResponse, the Function retrieves subsequent pages of SearchPagedResponse.

Parameters:

firstPageRetriever - Supplier that retrieves the first page

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

Method Details

getCoverage

@Deprecated
public Double getCoverage()

Deprecated.

Use SearchPagedResponse.getCoverage() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

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

@Deprecated
public Map<String, List<FacetResult>> getFacets()

Deprecated.

Use SearchPagedResponse.getFacets() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

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.

getTotalCount

@Deprecated
public Long getTotalCount()

Deprecated.

Use SearchPagedResponse.getCount() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

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.

getSemanticResults

@Deprecated
public SemanticSearchResults getSemanticResults()

Deprecated.

Use SearchPagedResponse.getSemanticResults() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

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.

getDebugInfo

@Deprecated
public DebugInfo getDebugInfo()

Deprecated.

Use SearchPagedResponse.getDebugInfo() when consuming ContinuablePagedIterable.streamByPage() or ContinuablePagedIterable.iterableByPage().

The debug information that can be used to further explore your search results.

Returns:

The debug information that can be used to further explore your search results.