Building Aggregations

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Building Aggregations

This page lists all the available aggregations with their corresponding AggregationBuilder class name and helper method name in the AggregationBuilders or PipelineAggregatorBuilders utility classes.

Metrics Aggregations

edit

Aggregation	AggregationBuilder Class	Method in AggregationBuilders
Avg	AvgAggregationBuilder	AggregationBuilders.avg()
Cardinality	CardinalityAggregationBuilder	AggregationBuilders.cardinality()
Extended Stats	ExtendedStatsAggregationBuilder	AggregationBuilders.extendedStats()
Geo Bounds	GeoBoundsAggregationBuilder	AggregationBuilders.geoBounds()
Geo Centroid	GeoCentroidAggregationBuilder	AggregationBuilders.geoCentroid()
Max	MaxAggregationBuilder	AggregationBuilders.max()
Min	MinAggregationBuilder	AggregationBuilders.min()
Percentiles	PercentilesAggregationBuilder	AggregationBuilders.percentiles()
Percentile Ranks	PercentileRanksAggregationBuilder	AggregationBuilders.percentileRanks()
Scripted Metric	ScriptedMetricAggregationBuilder	AggregationBuilders.scriptedMetric()
Stats	StatsAggregationBuilder	AggregationBuilders.stats()
Sum	SumAggregationBuilder	AggregationBuilders.sum()
Top hits	TopHitsAggregationBuilder	AggregationBuilders.topHits()
Top Metrics	TopMetricsAggregationBuilder	None
Value Count	ValueCountAggregationBuilder	AggregationBuilders.count()
String Stats	StringStatsAggregationBuilder	None

Bucket Aggregations

edit

Aggregation	AggregationBuilder Class	Method in AggregationBuilders
Adjacency Matrix	AdjacencyMatrixAggregationBuilder	AggregationBuilders.adjacencyMatrix()
Children	ChildrenAggregationBuilder
Date Histogram	DateHistogramAggregationBuilder	AggregationBuilders.dateHistogram()
Date Range	DateRangeAggregationBuilder	AggregationBuilders.dateRange()
Diversified Sampler	DiversifiedAggregationBuilder	AggregationBuilders.diversifiedSampler()
Filter	FilterAggregationBuilder	AggregationBuilders.filter()
Filters	FiltersAggregationBuilder	AggregationBuilders.filters()
Geo Distance	GeoDistanceAggregationBuilder	AggregationBuilders.geoDistance()
GeoHash Grid	GeoGridAggregationBuilder	AggregationBuilders.geohashGrid()
Global	GlobalAggregationBuilder	AggregationBuilders.global()
Histogram	HistogramAggregationBuilder	AggregationBuilders.histogram()
IP Range	IpRangeAggregationBuilder	AggregationBuilders.ipRange()
Missing	MissingAggregationBuilder	AggregationBuilders.missing()
Nested	NestedAggregationBuilder	AggregationBuilders.nested()
Range	RangeAggregationBuilder	AggregationBuilders.range()
Reverse nested	ReverseNestedAggregationBuilder	AggregationBuilders.reverseNested()
Sampler	SamplerAggregationBuilder	AggregationBuilders.sampler()
Significant Terms	SignificantTermsAggregationBuilder	AggregationBuilders.significantTerms()
Significant Text	SignificantTextAggregationBuilder	AggregationBuilders.significantText()
Terms	TermsAggregationBuilder	AggregationBuilders.terms()

Pipeline Aggregations

edit

Pipeline on	PipelineAggregationBuilder Class	Method in PipelineAggregatorBuilders
Avg Bucket	AvgBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.avgBucket()
Derivative	DerivativePipelineAggregationBuilder	PipelineAggregatorBuilders.derivative()
Inference	InferencePipelineAggregationBuilder	None
Max Bucket	MaxBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.maxBucket()
Min Bucket	MinBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.minBucket()
Sum Bucket	SumBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.sumBucket()
Stats Bucket	StatsBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.statsBucket()
Extended Stats Bucket	ExtendedStatsBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.extendedStatsBucket()
Percentiles Bucket	PercentilesBucketPipelineAggregationBuilder	PipelineAggregatorBuilders.percentilesBucket()
Moving Average	MovAvgPipelineAggregationBuilder	PipelineAggregatorBuilders.movingAvg()
Cumulative Sum	CumulativeSumPipelineAggregationBuilder	PipelineAggregatorBuilders.cumulativeSum()
Bucket Script	BucketScriptPipelineAggregationBuilder	PipelineAggregatorBuilders.bucketScript()
Bucket Selector	BucketSelectorPipelineAggregationBuilder	PipelineAggregatorBuilders.bucketSelector()
Serial Differencing	SerialDiffPipelineAggregationBuilder	PipelineAggregatorBuilders.diff()

Matrix Aggregations

edit

Aggregation	AggregationBuilder Class	Method in MatrixStatsAggregationBuilders
Matrix Stats	MatrixStatsAggregationBuilder	MatrixStatsAggregationBuilders.matrixStats()

« Building Queries Migration Guide »