Class AggregationResultItem

Aggregation result item

Inheritance

object

AggregationResultItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class AggregationResultItem

Properties

Active

True if the current result item matches on of the aggregation filters sent in the query.

Declaration

[JsonProperty("active", Required = Required.Always)]
public bool Active { get; set; }

Property Value

bool

AggregationResults

Inner aggregation results, if inner aggregations were provided in the query.

Declaration

[JsonProperty("aggregationResults", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<AggregationResult> AggregationResults { get; set; }

Property Value

ICollection<AggregationResult>

Count

Number of items matched.

Declaration

[JsonProperty("count", Required = Required.Always)]
public long Count { get; set; }

Property Value

long

Detail

Detailed information about the aggregation result item.

Declaration

[JsonProperty("detail", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public AggregationResultItemDetailBase Detail { get; set; }

Property Value

AggregationResultItemDetailBase

Filter

Ready to use filter to filter the data based on the aggregation result values.
It can be passed as one of the aggregation filters of an aggregation query: it returns documents meeting the aggregation condition.

Declaration

[JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public AggregationFilter Filter { get; set; }

Property Value

AggregationFilter

Name

Value matched.

Declaration

[JsonProperty("name", Required = Required.Always)]
[Required]
public string Name { get; set; }

Property Value

string

Methods

FromJson(string)

Declaration

public static AggregationResultItem FromJson(string data)

Parameters

string data

Returns

AggregationResultItem

ToJson()

Declaration

public string ToJson()

Returns

string