105 строки
8.0 KiB
YAML
105 строки
8.0 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.models.FacetResult"
|
|
fullName: "com.azure.search.documents.models.FacetResult"
|
|
name: "FacetResult"
|
|
nameWithType: "FacetResult"
|
|
summary: "A single bucket of a facet query result."
|
|
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 **FacetResult**</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.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.models.FacetResult.FacetResult()"
|
|
fullName: "com.azure.search.documents.models.FacetResult.FacetResult()"
|
|
name: "FacetResult()"
|
|
nameWithType: "FacetResult.FacetResult()"
|
|
summary: "Creates an instance of Facet<wbr>Result class."
|
|
syntax: "public FacetResult()"
|
|
desc: "Creates an instance of FacetResult class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.models.FacetResult.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.models.FacetResult.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "FacetResult.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Facet<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 FacetResult fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the FacetResult."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of FacetResult from the JsonReader."
|
|
returns:
|
|
description: "An instance of FacetResult 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.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.FacetResult.getAdditionalProperties()"
|
|
fullName: "com.azure.search.documents.models.FacetResult.getAdditionalProperties()"
|
|
name: "getAdditionalProperties()"
|
|
nameWithType: "FacetResult.getAdditionalProperties()"
|
|
summary: "Get the additional<wbr>Properties property: A single bucket of a facet query result."
|
|
syntax: "public Map<String,Object> getAdditionalProperties()"
|
|
desc: "Get the additionalProperties property: A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval."
|
|
returns:
|
|
description: "the additionalProperties value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
- uid: "com.azure.search.documents.models.FacetResult.getCount()"
|
|
fullName: "com.azure.search.documents.models.FacetResult.getCount()"
|
|
name: "getCount()"
|
|
nameWithType: "FacetResult.getCount()"
|
|
summary: "Get the count property: The approximate count of documents falling within the bucket described by this facet."
|
|
syntax: "public Long getCount()"
|
|
desc: "Get the count property: The approximate count of documents falling within the bucket described by this facet."
|
|
returns:
|
|
description: "the count value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.search.documents.models.FacetResult.setAdditionalProperties(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.azure.search.documents.models.FacetResult.setAdditionalProperties(Map<String,Object> additionalProperties)"
|
|
name: "setAdditionalProperties(Map<String,Object> additionalProperties)"
|
|
nameWithType: "FacetResult.setAdditionalProperties(Map<String,Object> additionalProperties)"
|
|
summary: "Set the additional<wbr>Properties property: A single bucket of a facet query result."
|
|
parameters:
|
|
- description: "the additionalProperties value to set."
|
|
name: "additionalProperties"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
syntax: "public FacetResult setAdditionalProperties(Map<String,Object> additionalProperties)"
|
|
desc: "Set the additionalProperties property: A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval."
|
|
returns:
|
|
description: "the FacetResult object itself."
|
|
type: "<xref href=\"com.azure.search.documents.models.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.models.FacetResult.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.models.FacetResult.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "FacetResult.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: "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval."
|
|
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.FacetResult?alt=com.azure.search.documents.models.FacetResult&text=FacetResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.models"
|
|
artifact: com.azure:azure-search-documents:11.7.1
|