95 строки
7.2 KiB
YAML
95 строки
7.2 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.AutocompleteResult"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult"
|
|
name: "AutocompleteResult"
|
|
nameWithType: "AutocompleteResult"
|
|
summary: "The result of Autocomplete query."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **AutocompleteResult**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.AutocompleteResult?alt=com.azure.search.documents.models.AutocompleteResult&text=AutocompleteResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.AutocompleteResult.AutocompleteResult(java.util.List<com.azure.search.documents.models.AutocompleteItem>)"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult.AutocompleteResult(List<AutocompleteItem> results)"
|
|
name: "AutocompleteResult(List<AutocompleteItem> results)"
|
|
nameWithType: "AutocompleteResult.AutocompleteResult(List<AutocompleteItem> results)"
|
|
summary: "Creates an instance of Autocomplete<wbr>Result class."
|
|
parameters:
|
|
- description: "the results value to set."
|
|
name: "results"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.models.AutocompleteItem?alt=com.azure.search.documents.models.AutocompleteItem&text=AutocompleteItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public AutocompleteResult(List<AutocompleteItem> results)"
|
|
desc: "Creates an instance of AutocompleteResult class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.AutocompleteResult.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "AutocompleteResult.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Autocomplete<wbr>Result from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static AutocompleteResult fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of AutocompleteResult from the JsonReader."
|
|
returns:
|
|
description: "An instance of AutocompleteResult if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.models.AutocompleteResult?alt=com.azure.search.documents.models.AutocompleteResult&text=AutocompleteResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.AutocompleteResult.getCoverage()"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult.getCoverage()"
|
|
name: "getCoverage()"
|
|
nameWithType: "AutocompleteResult.getCoverage()"
|
|
summary: "Get the coverage property: A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimum<wbr>Coverage was not specified in the request."
|
|
syntax: "public Double getCoverage()"
|
|
desc: "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:
|
|
description: "the coverage value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
- uid: "com.azure.search.documents.models.AutocompleteResult.getResults()"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult.getResults()"
|
|
name: "getResults()"
|
|
nameWithType: "AutocompleteResult.getResults()"
|
|
summary: "Get the results property: The list of returned Autocompleted items."
|
|
syntax: "public List<AutocompleteItem> getResults()"
|
|
desc: "Get the results property: The list of returned Autocompleted items."
|
|
returns:
|
|
description: "the results value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.models.AutocompleteItem?alt=com.azure.search.documents.models.AutocompleteItem&text=AutocompleteItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.models.AutocompleteResult.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.models.AutocompleteResult.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "AutocompleteResult.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The result of Autocomplete query."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.models.AutocompleteResult?alt=com.azure.search.documents.models.AutocompleteResult&text=AutocompleteResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|