Section navigation

Public classSealed AggregationRequest

Namespace
Rowles.LeanCorpus.Search.Aggregations
Assembly
Rowles.LeanCorpus.dll

Describes a numeric aggregation to compute alongside a search query.

public sealed class AggregationRequest
Inheritance
AggregationRequest

Public constructor AggregationRequest(string, string, AggregationType)

Initialises a new AggregationRequest.

Public property CardinalityPrecision

HyperLogLog++ precision from 4 to 18. Higher precision uses more memory.

Public property Field

Numeric doc-values field to aggregate over.

Public property HdrHighestTrackableValue

HDR highest trackable Int64 value.

Public property HdrSignificantDigits

HDR significant decimal digits from 1 to 5.

Public property HistogramInterval

Histogram bucket width (only used when Type is Histogram).

Public property Name

Caller-defined label for this aggregation.

Public property Percentiles

Requested percentiles in the inclusive range 0 to 100.

Public property TDigestCompression

t-digest compression from 20 to 1,000. Higher values retain more centroids.

Public property Type

The kind of aggregation to compute.