com.azure.search.models

Class SearchDocumentsResult

java.lang.Object

com.azure.search.models.SearchDocumentsResult

public final class SearchDocumentsResult
extends Object

Response containing search results from an index.

Constructor Summary

Constructors

Constructor and Description
SearchDocumentsResult()

Method Summary

Modifier and Type	Method and Description
Long	getCount() Get the count property: The total count of results found by the search operation, or null if the count was not requested.
Double	getCoverage() Get the coverage property: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request.
Map<String,List<FacetResult>>	getFacets() Get the facets property: The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions.
String	getNextLink() Get the nextLink property: Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response.
SearchRequest	getNextPageParameters() Get the nextPageParameters property: Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response.
List<SearchResult>	getResults() Get the results property: The sequence of results returned by the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchDocumentsResult

public SearchDocumentsResult()

Method Detail

getCount

public Long getCount()

Get the count property: The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response.

Returns:

the count value.

getCoverage

public Double getCoverage()

Get the coverage property: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request.

Returns:

the coverage value.

getFacets

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

Get the facets property: The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions.

Returns:

the facets value.

getNextPageParameters

public SearchRequest getNextPageParameters()

Get the nextPageParameters property: Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response.

Returns:

the nextPageParameters value.

getResults

public List<SearchResult> getResults()

Get the results property: The sequence of results returned by the query.

Returns:

the results value.

getNextLink

public String getNextLink()

Get the nextLink property: Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response.

Returns:

the nextLink value.