com.azure.search.util

Class SearchPagedResponse

java.lang.Object

com.azure.search.util.SearchPagedResponse

All Implemented Interfaces:

com.azure.core.http.rest.Response<List<SearchResult>>, com.azure.core.util.paging.ContinuablePage<SearchRequest,SearchResult>

public final class SearchPagedResponse
extends Object
implements com.azure.core.util.paging.ContinuablePage<SearchRequest,SearchResult>, com.azure.core.http.rest.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(com.azure.core.http.rest.SimpleResponse<SearchDocumentsResult> documentSearchResponse) Constructor

Method Summary

Modifier and Type	Method and Description
SearchRequest	getContinuationToken()
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.
com.azure.core.util.IterableStream<SearchResult>	getElements()
Map<String,List<FacetResult>>	getFacets() The facet query results based on the search request.
com.azure.core.http.HttpHeaders	getHeaders()
com.azure.core.http.HttpRequest	getRequest()
int	getStatusCode()
List<SearchResult>	getValue()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchPagedResponse

public SearchPagedResponse(com.azure.core.http.rest.SimpleResponse<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()

Specified by:

getStatusCode in interface com.azure.core.http.rest.Response<List<SearchResult>>

getHeaders

public com.azure.core.http.HttpHeaders getHeaders()

Specified by:

getHeaders in interface com.azure.core.http.rest.Response<List<SearchResult>>

getRequest

public com.azure.core.http.HttpRequest getRequest()

Specified by:

getRequest in interface com.azure.core.http.rest.Response<List<SearchResult>>

getValue

public List<SearchResult> getValue()

Specified by:

getValue in interface com.azure.core.http.rest.Response<List<SearchResult>>

getElements

public com.azure.core.util.IterableStream<SearchResult> getElements()

Specified by:

getElements in interface com.azure.core.util.paging.ContinuablePage<SearchRequest,SearchResult>

getContinuationToken

public SearchRequest getContinuationToken()

Specified by:

getContinuationToken in interface com.azure.core.util.paging.ContinuablePage<SearchRequest,SearchResult>