Class ObjectAggregationResult

Result for an aggregation operation

Inheritance
object
ObjectAggregationResult
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Syntax
[GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ObjectAggregationResult

Properties

AggregationResults

Results of the aggregation.

Declaration
[JsonProperty("aggregationResults", Required = Required.Always)]
[Required]
public ICollection<AggregationResult> AggregationResults { get; set; }
Property Value
ICollection<AggregationResult>

ElapsedMilliseconds

How long did the search and aggregation took.

Declaration
[JsonProperty("elapsedMilliseconds", Required = Required.Always)]
public long ElapsedMilliseconds { get; set; }
Property Value
long

IsSearchStringRewritten

Flag to notify if the SearchString was modified compared to the original requested one.

Declaration
[JsonProperty("isSearchStringRewritten", Required = Required.Always)]
public bool IsSearchStringRewritten { get; set; }
Property Value
bool

QueryDebugInformation

Additional information regarding the query execution and reason of the matched documents. Multiple items are returned if multiple queries were performed.

Declaration
[JsonProperty("queryDebugInformation", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public ICollection<QueryDebugInformation> QueryDebugInformation { get; set; }
Property Value
ICollection<QueryDebugInformation>

SearchString

Search string used to query the data

Declaration
[JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
public string SearchString { get; set; }
Property Value
string

Methods

FromJson(string)

Declaration
public static ObjectAggregationResult FromJson(string data)
Parameters
string data

Returns
ObjectAggregationResult

GetByName(string)

Gets an aggregation result by name.

Declaration
public AggregationResult GetByName(string name)
Parameters
string name

The name.
Returns
AggregationResult

The aggregation result or null.

ToJson()

Declaration
public string ToJson()
Returns
string