Class TermsAggregator
A multi-bucket value aggregator
Inheritance
TermsAggregator
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class TermsAggregator : AggregatorBase
Properties
Excludes values for which buckets will be created. Supports regular expression strings or arrays of exact values.
Declaration
[JsonProperty("excludes", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> Excludes { get; set; }
Property Value
The field's ID to execute the aggregation on. Only not analyzed fields are supported.
Declaration
[JsonProperty("field", Required = Required.Always)]
[Required]
public string Field { get; set; }
Property Value
Includes values for which buckets will be created. Supports regular expression strings or arrays of exact values.
Declaration
[JsonProperty("includes", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> Includes { get; set; }
Property Value
Search fields to be used to search the SearchString value into. If no search field is specified, the Field value is used.
Declaration
[JsonProperty("searchFields", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<string> SearchFields { get; set; }
Property Value
Limits the possible returned aggregation values by using a query string filter. The Lucene query string syntax is supported.
Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }
Property Value
It defines how many term buckets should be returned out of the overall terms list.
Declaration
[JsonProperty("size", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public int? Size { get; set; }
Property Value
Sort settings for the aggregation results. If no sort is specified, aggregation is sorted on the item count.
Declaration
[JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public SortInfo Sort { get; set; }
Property Value
Methods
Declaration
public static TermsAggregator FromJson(string data)
Parameters
Returns