Share via

FacetResult Class

  • Reference
Package:
com.azure.search.documents.models
Maven Artifact:
com.azure:azure-search-documents:11.7.3
  • java.lang.Object
    • com.azure.search.documents.models.FacetResult

Implements

JsonSerializable<FacetResult>

public final class FacetResult
implements JsonSerializable<FacetResult>

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.

Constructor Summary

Constructor Description
FacetResult()

Creates an instance of FacetResult class.

Method Summary

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

Reads an instance of FacetResult from the JsonReader.
Map<String,Object> getAdditionalProperties()

Get the additionalProperties property: A single bucket of a facet query result.
Long getCount()

Get the count property: The approximate count of documents falling within the bucket described by this facet.
FacetResult setAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: A single bucket of a facet query result.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FacetResult

public FacetResult()

Creates an instance of FacetResult class.

Method Details

fromJson

public static FacetResult fromJson(JsonReader jsonReader)

Reads an instance of FacetResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the FacetResult.

getAdditionalProperties

public Map getAdditionalProperties()

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:

the additionalProperties value.

getCount

public Long getCount()

Get the count property: The approximate count of documents falling within the bucket described by this facet.

Returns:

the count value.

setAdditionalProperties

public FacetResult setAdditionalProperties(Map additionalProperties)

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.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the FacetResult object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to