Class TermsAggregator
A multi-bucket value aggregator
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
public class TermsAggregator : AggregatorBase
Properties
Excludes
Excludes values for which buckets will be created. Supports regular expression strings or arrays of exact values.
Declaration
public ICollection<string> Excludes { get; set; }
Property Value
System.Collections.Generic.ICollection<System.String>
|
Field
The field's ID to execute the aggregation on. Only not analyzed fields are supported.
Declaration
public string Field { get; set; }
Property Value
System.String
|
Includes
Includes values for which buckets will be created. Supports regular expression strings or arrays of exact values.
Declaration
public ICollection<string> Includes { get; set; }
Property Value
System.Collections.Generic.ICollection<System.String>
|
SearchFields
Search fields to be used to search the SearchString value into. If no search field is specified, the Field value is used.
Declaration
public ICollection<string> SearchFields { get; set; }
Property Value
System.Collections.Generic.ICollection<System.String>
|
SearchString
Limits the possible returned aggregation values by using a query string filter. The Lucene query string syntax is supported.
Declaration
public string SearchString { get; set; }
Property Value
System.String
|
Size
It defines how many term buckets should be returned out of the overall terms list.
Declaration
public int? Size { get; set; }
Property Value
System.Nullable<System.Int32>
|
Sort
Sort settings for the aggregation results. If no sort is specified, aggregation is sorted on the item count.
Declaration
public SortInfo Sort { get; set; }
Property Value
SortInfo
|
Methods
FromJson(String)
Declaration
public static TermsAggregator FromJson(string data)
Parameters
System.String
data
|
Returns
TermsAggregator
|
ToJson()
Declaration
public string ToJson()
Returns
System.String
|