SearchPagedResponse Class

public final class SearchPagedResponse
extends PagedResponseBase<Void,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

Constructor Description
SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage)

Constructor

SearchPagedResponse(Response<List<SearchResult>> response, String continuationToken, Map<String,List<FacetResult>> facets, Long count, Double coverage, List<QueryAnswerResult> queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)

Constructor

Method Summary

Modifier and Type Method and Description
List<SearchResult> getValue()

Methods inherited from PagedResponseBase

Methods inherited from java.lang.Object

Constructor Details

SearchPagedResponse

public SearchPagedResponse(Response> response, String continuationToken, Map> 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> response, String continuationToken, Map> facets, Long count, Double coverage, List queryAnswers, SemanticErrorReason semanticErrorReason, SemanticSearchResultsType semanticSearchResultsType)

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.
queryAnswers - Answers contained in the search.
semanticErrorReason - Reason that a partial response was returned for a semantic search request.
semanticSearchResultsType - Type of the partial response returned for a semantic search request.

Method Details

getValue

public List getValue()

Applies to