Class AggregateDictionary

Contains aggregates that are returned by OpenSearch. In OSC, Aggregation always refers to an aggregation request to OpenSearch and an Aggregate describes an aggregation response.

Inheritance
object
IsAReadOnlyDictionaryBase<string, IAggregate>
AggregateDictionary
BucketAggregateBase
BucketBase
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class AggregateDictionary : IsAReadOnlyDictionaryBase<string, IAggregate>, IIsAReadOnlyDictionary<string, IAggregate>, IReadOnlyDictionary<string, IAggregate>, IReadOnlyCollection<KeyValuePair<string, IAggregate>>, IEnumerable<KeyValuePair<string, IAggregate>>, IEnumerable, IIsAReadOnlyDictionary

Constructors

| Edit this page View Source

AggregateDictionary(IReadOnlyDictionary<string, IAggregate>)

Declaration
public AggregateDictionary(IReadOnlyDictionary<string, IAggregate> backingDictionary)
Parameters
Type Name Description
IReadOnlyDictionary<string, IAggregate> backingDictionary

Properties

| Edit this page View Source

Default

Declaration
public static AggregateDictionary Default { get; }
Property Value
Type Description
AggregateDictionary

Methods

| Edit this page View Source

AdjacencyMatrix(string)

Declaration
public MultiBucketAggregate<KeyedBucket<string>> AdjacencyMatrix(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<KeyedBucket<string>>
| Edit this page View Source

AutoDateHistogram(string)

Declaration
public AutoDateHistogramAggregate AutoDateHistogram(string key)
Parameters
Type Name Description
string key
Returns
Type Description
AutoDateHistogramAggregate
| Edit this page View Source

Average(string)

Declaration
public ValueAggregate Average(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

AverageBucket(string)

Declaration
public ValueAggregate AverageBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

BucketScript(string)

Declaration
public ValueAggregate BucketScript(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

Cardinality(string)

Declaration
public ValueAggregate Cardinality(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

Children(string)

Declaration
public SingleBucketAggregate Children(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Composite(string)

Declaration
public CompositeBucketAggregate Composite(string key)
Parameters
Type Name Description
string key
Returns
Type Description
CompositeBucketAggregate
| Edit this page View Source

CumulativeSum(string)

Declaration
public ValueAggregate CumulativeSum(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

DateHistogram(string)

Declaration
public MultiBucketAggregate<DateHistogramBucket> DateHistogram(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<DateHistogramBucket>
| Edit this page View Source

DateRange(string)

Declaration
public MultiBucketAggregate<RangeBucket> DateRange(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<RangeBucket>
| Edit this page View Source

Derivative(string)

Declaration
public ValueAggregate Derivative(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

DiversifiedSampler(string)

Declaration
public SingleBucketAggregate DiversifiedSampler(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

ExtendedStats(string)

Declaration
public ExtendedStatsAggregate ExtendedStats(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ExtendedStatsAggregate
| Edit this page View Source

ExtendedStatsBucket(string)

Declaration
public ExtendedStatsAggregate ExtendedStatsBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ExtendedStatsAggregate
| Edit this page View Source

Filter(string)

Declaration
public SingleBucketAggregate Filter(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Filters(string)

Declaration
public FiltersAggregate Filters(string key)
Parameters
Type Name Description
string key
Returns
Type Description
FiltersAggregate
| Edit this page View Source

GeoBounds(string)

Declaration
public GeoBoundsAggregate GeoBounds(string key)
Parameters
Type Name Description
string key
Returns
Type Description
GeoBoundsAggregate
| Edit this page View Source

GeoCentroid(string)

Declaration
public GeoCentroidAggregate GeoCentroid(string key)
Parameters
Type Name Description
string key
Returns
Type Description
GeoCentroidAggregate
| Edit this page View Source

GeoDistance(string)

Declaration
public MultiBucketAggregate<RangeBucket> GeoDistance(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<RangeBucket>
| Edit this page View Source

GeoHash(string)

Declaration
public MultiBucketAggregate<KeyedBucket<string>> GeoHash(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<KeyedBucket<string>>
| Edit this page View Source

GeoLine(string)

Declaration
public GeoLineAggregate GeoLine(string key)
Parameters
Type Name Description
string key
Returns
Type Description
GeoLineAggregate
| Edit this page View Source

GeoTile(string)

Declaration
public MultiBucketAggregate<KeyedBucket<string>> GeoTile(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<KeyedBucket<string>>
| Edit this page View Source

Global(string)

Declaration
public SingleBucketAggregate Global(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Histogram(string)

Declaration
public MultiBucketAggregate<KeyedBucket<double>> Histogram(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<KeyedBucket<double>>
| Edit this page View Source

IpRange(string)

Declaration
public MultiBucketAggregate<IpRangeBucket> IpRange(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<IpRangeBucket>
| Edit this page View Source

MatrixStats(string)

Declaration
public MatrixStatsAggregate MatrixStats(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MatrixStatsAggregate
| Edit this page View Source

Max(string)

Declaration
public ValueAggregate Max(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

MaxBucket(string)

Declaration
public KeyedValueAggregate MaxBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
KeyedValueAggregate
| Edit this page View Source

MedianAbsoluteDeviation(string)

Declaration
public ValueAggregate MedianAbsoluteDeviation(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

Min(string)

Declaration
public ValueAggregate Min(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

MinBucket(string)

Declaration
public KeyedValueAggregate MinBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
KeyedValueAggregate
| Edit this page View Source

Missing(string)

Declaration
public SingleBucketAggregate Missing(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

MovingAverage(string)

Declaration
public ValueAggregate MovingAverage(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

MultiTerms(string)

Declaration
public MultiTermsAggregate<string> MultiTerms(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiTermsAggregate<string>
| Edit this page View Source

MultiTerms<TKey>(string)

Declaration
public MultiTermsAggregate<TKey> MultiTerms<TKey>(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiTermsAggregate<TKey>
Type Parameters
Name Description
TKey
| Edit this page View Source

Nested(string)

Declaration
public SingleBucketAggregate Nested(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Normalize(string)

Declaration
public ValueAggregate Normalize(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

Parent(string)

Declaration
public SingleBucketAggregate Parent(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

PercentileRanks(string)

Declaration
public PercentilesAggregate PercentileRanks(string key)
Parameters
Type Name Description
string key
Returns
Type Description
PercentilesAggregate
| Edit this page View Source

Percentiles(string)

Declaration
public PercentilesAggregate Percentiles(string key)
Parameters
Type Name Description
string key
Returns
Type Description
PercentilesAggregate
| Edit this page View Source

PercentilesBucket(string)

Declaration
public PercentilesAggregate PercentilesBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
PercentilesAggregate
| Edit this page View Source

Range(string)

Declaration
public MultiBucketAggregate<RangeBucket> Range(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<RangeBucket>
| Edit this page View Source

RareTerms(string)

Declaration
public MultiBucketAggregate<RareTermsBucket<string>> RareTerms(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<RareTermsBucket<string>>
| Edit this page View Source

RareTerms<TKey>(string)

Declaration
public MultiBucketAggregate<RareTermsBucket<TKey>> RareTerms<TKey>(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<RareTermsBucket<TKey>>
Type Parameters
Name Description
TKey
| Edit this page View Source

ReverseNested(string)

Declaration
public SingleBucketAggregate ReverseNested(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Sampler(string)

Declaration
public SingleBucketAggregate Sampler(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SingleBucketAggregate
| Edit this page View Source

Sanitize(string)

Declaration
protected override string Sanitize(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string
Overrides
| Edit this page View Source

ScriptedMetric(string)

Declaration
public ScriptedMetricAggregate ScriptedMetric(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ScriptedMetricAggregate
| Edit this page View Source

SerialDifferencing(string)

Declaration
public ValueAggregate SerialDifferencing(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

SignificantTerms(string)

Declaration
public SignificantTermsAggregate<string> SignificantTerms(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SignificantTermsAggregate<string>
| Edit this page View Source

SignificantTerms<TKey>(string)

Declaration
public SignificantTermsAggregate<TKey> SignificantTerms<TKey>(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SignificantTermsAggregate<TKey>
Type Parameters
Name Description
TKey
| Edit this page View Source

SignificantText(string)

Declaration
public SignificantTermsAggregate<string> SignificantText(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SignificantTermsAggregate<string>
| Edit this page View Source

SignificantText<TKey>(string)

Declaration
public SignificantTermsAggregate<TKey> SignificantText<TKey>(string key)
Parameters
Type Name Description
string key
Returns
Type Description
SignificantTermsAggregate<TKey>
Type Parameters
Name Description
TKey
| Edit this page View Source

Stats(string)

Declaration
public StatsAggregate Stats(string key)
Parameters
Type Name Description
string key
Returns
Type Description
StatsAggregate
| Edit this page View Source

StatsBucket(string)

Declaration
public StatsAggregate StatsBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
StatsAggregate
| Edit this page View Source

Sum(string)

Declaration
public ValueAggregate Sum(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

SumBucket(string)

Declaration
public ValueAggregate SumBucket(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

Terms(string)

Declaration
public TermsAggregate<string> Terms(string key)
Parameters
Type Name Description
string key
Returns
Type Description
TermsAggregate<string>
| Edit this page View Source

Terms<TKey>(string)

Declaration
public TermsAggregate<TKey> Terms<TKey>(string key)
Parameters
Type Name Description
string key
Returns
Type Description
TermsAggregate<TKey>
Type Parameters
Name Description
TKey
| Edit this page View Source

TopHits(string)

Declaration
public TopHitsAggregate TopHits(string key)
Parameters
Type Name Description
string key
Returns
Type Description
TopHitsAggregate
| Edit this page View Source

ValueCount(string)

Declaration
public ValueAggregate ValueCount(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate
| Edit this page View Source

VariableWidthHistogram(string)

Declaration
public MultiBucketAggregate<VariableWidthHistogramBucket> VariableWidthHistogram(string key)
Parameters
Type Name Description
string key
Returns
Type Description
MultiBucketAggregate<VariableWidthHistogramBucket>
| Edit this page View Source

WeightedAverage(string)

Declaration
public ValueAggregate WeightedAverage(string key)
Parameters
Type Name Description
string key
Returns
Type Description
ValueAggregate

Implements

Extension Methods