Package org.elasticsearch.search.aggregations

Interface BaseAggregationBuilder

All Known Implementing Classes:

AbstractAggregationBuilder, AbstractPercentilesAggregationBuilder, AbstractPipelineAggregationBuilder, AbstractRangeBuilder, AdjacencyMatrixAggregationBuilder, AggregationBuilder, AutoDateHistogramAggregationBuilder, AvgAggregationBuilder, AvgBucketPipelineAggregationBuilder, BucketMetricsPipelineAggregationBuilder, BucketScriptPipelineAggregationBuilder, BucketSelectorPipelineAggregationBuilder, BucketSortPipelineAggregationBuilder, CardinalityAggregationBuilder, CompositeAggregationBuilder, CumulativeSumPipelineAggregationBuilder, DateHistogramAggregationBuilder, DateRangeAggregationBuilder, DerivativePipelineAggregationBuilder, DiversifiedAggregationBuilder, ExtendedStatsAggregationBuilder, ExtendedStatsBucketPipelineAggregationBuilder, FilterAggregationBuilder, FiltersAggregationBuilder, GeoBoundsAggregationBuilder, GeoCentroidAggregationBuilder, GeoDistanceAggregationBuilder, GeoGridAggregationBuilder, GeoHashGridAggregationBuilder, GeoTileGridAggregationBuilder, GlobalAggregationBuilder, HistogramAggregationBuilder, IpRangeAggregationBuilder, MaxAggregationBuilder, MaxBucketPipelineAggregationBuilder, MedianAbsoluteDeviationAggregationBuilder, MinAggregationBuilder, MinBucketPipelineAggregationBuilder, MissingAggregationBuilder, MovAvgPipelineAggregationBuilder, MovFnPipelineAggregationBuilder, MultiValuesSourceAggregationBuilder, MultiValuesSourceAggregationBuilder.LeafOnly, NestedAggregationBuilder, PercentileRanksAggregationBuilder, PercentilesAggregationBuilder, PercentilesBucketPipelineAggregationBuilder, PipelineAggregationBuilder, RangeAggregationBuilder, RareTermsAggregationBuilder, ReverseNestedAggregationBuilder, SamplerAggregationBuilder, ScriptedMetricAggregationBuilder, SerialDiffPipelineAggregationBuilder, SignificantTermsAggregationBuilder, SignificantTextAggregationBuilder, StatsAggregationBuilder, StatsBucketPipelineAggregationBuilder, SumAggregationBuilder, SumBucketPipelineAggregationBuilder, TermsAggregationBuilder, TopHitsAggregationBuilder, ValueCountAggregationBuilder, ValuesSourceAggregationBuilder, ValuesSourceAggregationBuilder.LeafOnly, VariableWidthHistogramAggregationBuilder, WeightedAvgAggregationBuilder

public interface BaseAggregationBuilder

Interface shared by AggregationBuilder and PipelineAggregationBuilder so they can conveniently share the same namespace for XContentParser.namedObject(Class, String, Object).

Method Summary

Modifier and Type	Method	Description
String	getType()	The name of the type of aggregation built by this builder.
BaseAggregationBuilder	setMetadata(Map<String,Object> metadata)	Set the aggregation's metadata.
BaseAggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories)	Set the sub aggregations if this aggregation supports sub aggregations.

Method Details

getType

String getType()

The name of the type of aggregation built by this builder.

setMetadata

BaseAggregationBuilder setMetadata(Map<String,Object> metadata)

Set the aggregation's metadata. Returns this for chaining.

subAggregations

BaseAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Set the sub aggregations if this aggregation supports sub aggregations. Returns this for chaining.