AutocompleteResult 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.AutocompleteResult

Implements

JsonSerializable<AutocompleteResult>

public final class AutocompleteResult
implements JsonSerializable<AutocompleteResult>

The result of Autocomplete query.

Method Summary

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

Reads an instance of AutocompleteResult from the JsonReader.
Double getCoverage()

Get the coverage property: A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request.
List<AutocompleteItem> getResults()

Get the results property: The list of returned Autocompleted items.
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 AutocompleteResult fromJson(JsonReader jsonReader)

Reads an instance of AutocompleteResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AutocompleteResult 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 considered by the autocomplete request, or null if minimumCoverage was not specified in the request.

Returns:

the coverage value.

getResults

public List<AutocompleteItem> getResults()

Get the results property: The list of returned Autocompleted items.

Returns:

the results value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to