com.azure.search.util

Class SearchPagedResponse

java.lang.Object

com.azure.search.util.SearchPagedResponse

All Implemented Interfaces:

Response<List<SearchResult>>, ContinuablePage<SearchRequest,SearchResult>

public final class SearchPagedResponse
extends Object
implements ContinuablePage<SearchRequest,SearchResult>, Response<List<SearchResult>>

Represents an HTTP response from the search API request that contains a list of items deserialized into a Page. Each page contains additional information returned by the API request. In the Search API case the additional information is: count - number of total documents returned. Will be returned only if isIncludeTotalResultCount is set to true coverage - coverage value.

Constructor Summary

Constructors

Constructor and Description
SearchPagedResponse(SimpleResponse<com.azure.search.implementation.models.SearchDocumentsResult> documentSearchResponse) Constructor

Method Summary

Modifier and Type	Method and Description
SearchRequest	getContinuationToken() Gets the reference to the next page.
Long	getCount() The approximate number of documents that matched the search and filter parameters in the request.
Double	getCoverage() The percentage of the index covered in the search request.
IterableStream<SearchResult>	getElements() Gets an IterableStream of elements in the page.
Map<String,List<FacetResult>>	getFacets() The facet query results based on the search request.
HttpHeaders	getHeaders() Gets the headers from the HTTP response.
HttpRequest	getRequest() Gets the HTTP request which resulted in this response.
int	getStatusCode() Gets the HTTP response status code.
List<SearchResult>	getValue() Gets the deserialized value of the HTTP response.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchPagedResponse

public SearchPagedResponse(SimpleResponse<com.azure.search.implementation.models.SearchDocumentsResult> documentSearchResponse)

Constructor

Parameters:

documentSearchResponse - an http response with the results

Method Detail

getCoverage

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

getCount

public Long getCount()

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.

getStatusCode

public int getStatusCode()

Description copied from interface: Response

Gets the HTTP response status code.

Specified by:

getStatusCode in interface Response<List<SearchResult>>

Returns:

The status code of the HTTP response.

getHeaders

public HttpHeaders getHeaders()

Description copied from interface: Response

Gets the headers from the HTTP response.

Specified by:

getHeaders in interface Response<List<SearchResult>>

Returns:

The HTTP response headers.

getRequest

public HttpRequest getRequest()

Description copied from interface: Response

Gets the HTTP request which resulted in this response.

Specified by:

getRequest in interface Response<List<SearchResult>>

Returns:

The HTTP request.

getValue

public List<SearchResult> getValue()

Description copied from interface: Response

Gets the deserialized value of the HTTP response.

Specified by:

getValue in interface Response<List<SearchResult>>

Returns:

The deserialized value of the HTTP response.

getElements

public IterableStream<SearchResult> getElements()

Description copied from interface: ContinuablePage

Gets an IterableStream of elements in the page.

Specified by:

getElements in interface ContinuablePage<SearchRequest,SearchResult>

Returns:

An IterableStream containing the elements in the page.

getContinuationToken

public SearchRequest getContinuationToken()

Description copied from interface: ContinuablePage

Gets the reference to the next page.

Specified by:

getContinuationToken in interface ContinuablePage<SearchRequest,SearchResult>

Returns:

The next page reference or null if there isn't a next page.