Package com.azure.search.documents.util
Class SearchPagedResponse
java.lang.Object
com.azure.core.http.rest.PagedResponseBase<Void,SearchResult>
com.azure.search.documents.util.SearchPagedResponse
- All Implemented Interfaces:
Page<SearchResult>
,PagedResponse<SearchResult>
,Response<List<SearchResult>>
,ContinuablePage<String,
,SearchResult> Closeable
,AutoCloseable
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
ConstructorDescriptionSearchPagedResponse
(Response<List<SearchResult>> response, String continuationToken, Map<String, List<FacetResult>> facets, Long count, Double coverage) ConstructorSearchPagedResponse
(Response<List<SearchResult>> response, String continuationToken, Map<String, List<FacetResult>> facets, Long count, Double coverage, List<AnswerResult> answers) Constructor -
Method Summary
Methods inherited from class com.azure.core.http.rest.PagedResponseBase
close, getContinuationToken, getDeserializedHeaders, getElements, getHeaders, getRequest, getStatusCode
-
Constructor Details
-
SearchPagedResponse
public SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String, List<FacetResult>> facets, Long count, Double coverage) Constructor- Parameters:
response
- The response containing information such as the request, status code, headers, and values.continuationToken
- Continuation token for the next operation.facets
- Facets contained in the search.count
- Total number of documents available as a result for the search.coverage
- Percent of the index used in the search operation.
-
SearchPagedResponse
public SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String, List<FacetResult>> facets, Long count, Double coverage, List<AnswerResult> answers) Constructor- Parameters:
response
- The response containing information such as the request, status code, headers, and values.continuationToken
- Continuation token for the next operation.facets
- Facets contained in the search.count
- Total number of documents available as a result for the search.coverage
- Percent of the index used in the search operation.answers
- Answers contained in the search.
-
-
Method Details
-
getValue
Description copied from interface:PagedResponse
Returns the items in the page.- Returns:
- The items in the page.
-