SuggestDocumentsResult Class

Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0
  • java.lang.Object
    • com.azure.search.documents.models.SuggestDocumentsResult

Implements

JsonSerializable<SuggestDocumentsResult>

public final class SuggestDocumentsResult
implements JsonSerializable<SuggestDocumentsResult>

Response containing suggestion query results from an index.

Method Summary

Modifier and Type Method and Description
static SuggestDocumentsResult fromJson(JsonReader jsonReader)

Reads an instance of SuggestDocumentsResult from the JsonReader.
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 set in the request.
List<SuggestResult> getResults()

Get the results property: The sequence of results returned by the query.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static SuggestDocumentsResult fromJson(JsonReader jsonReader)

Reads an instance of SuggestDocumentsResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SuggestDocumentsResult if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

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 set in the request.

Returns:

the coverage value.

getResults

public List<SuggestResult> getResults()

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

Returns:

the results value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to