FacetResult Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Data.dll

Package:

Microsoft.Azure.Search.Data v10.1.0

Source:

FacetResult.cs

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.

public class FacetResult

type FacetResult = class

Public Class FacetResult

Inheritance

Object

FacetResult

Constructors

FacetResult(Object, Object, Object, Nullable<Int64>)

Initializes a new instance of the FacetResult class. This constructor is intended to be used for test purposes, since the properties of this class are immutable.

Properties

Count	Gets the approximate count of documents falling within the bucket described by this facet.
From	Gets a value indicating the inclusive lower bound of the facet's range, or null to indicate that there is no lower bound (i.e. -- for the first bucket).
To	Gets a value indicating the exclusive upper bound of the facet's range, or null to indicate that there is no upper bound (i.e. -- for the last bucket).
Type	Gets a value indicating the type of this facet.
Value	Gets the value of the facet, or the inclusive lower bound if it's an interval facet.

Methods

AsRangeFacetResult<T>()	Attempts to convert the facet to a range facet of the given type.
AsValueFacetResult<T>()	Attempts to convert the facet to a value facet of the given type.