FacetResult Class

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.5.1

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 : System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IReadOnlyCollection<System.Collections.Generic.KeyValuePair<string,object>>, System.Collections.Generic.IReadOnlyDictionary<string,object>

type FacetResult = class
    interface IReadOnlyDictionary<string, obj>
    interface seq<KeyValuePair<string, obj>>
    interface IEnumerable
    interface IReadOnlyCollection<KeyValuePair<string, obj>>

Public Class FacetResult
Implements IEnumerable(Of KeyValuePair(Of String, Object)), IReadOnlyCollection(Of KeyValuePair(Of String, Object)), IReadOnlyDictionary(Of String, Object)

Inheritance

Object

FacetResult

Implements

IEnumerable<KeyValuePair<String,Object>> IEnumerable<KeyValuePair<TKey,TValue>> IEnumerable<T> IReadOnlyCollection<KeyValuePair<String,Object>> IReadOnlyCollection<KeyValuePair<TKey,TValue>> IReadOnlyDictionary<String,Object> IEnumerable

Properties

Count	The approximate count of documents falling within the bucket described by this facet.
FacetType	Gets the type of this facet. Value facets count documents with a particular field value and Range facets count documents with a field value in a particular range.
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).
Item[String]	Gets the element that has the specified key in the read-only dictionary.
Keys	Gets an enumerable collection that contains the keys in the read-only dictionary.
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).
Value	Gets the value of the facet, or the inclusive lower bound if it's an interval facet.
Values	Gets an enumerable collection that contains the values in the read-only dictionary.

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.
ContainsKey(String)	Determines whether the read-only dictionary contains an element that has the specified key.
GetEnumerator()	Returns an enumerator that iterates through the collection.
TryGetValue(String, Object)	Gets the value that is associated with the specified key.

Explicit Interface Implementations

IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IReadOnlyCollection<KeyValuePair<String,Object>>.Count	Gets the number of elements in the collection.