org.elasticsearch.search.aggregations

Interface Aggregation

All Known Subinterfaces:

Avg, Cardinality, Children, Derivative, ExtendedStats, ExtendedStatsBucket, Filter, Filters, GeoBounds, GeoCentroid, GeoHashGrid, Global, Histogram, Max, Min, Missing, MultiBucketsAggregation, Nested, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue, PercentileRanks, Percentiles, PercentilesBucket, Range, ReverseNested, Sampler, ScriptedMetric, SignificantTerms, SimpleValue, SingleBucketAggregation, Stats, StatsBucket, Sum, Terms, TopHits, ValueCount

All Known Implementing Classes:

DoubleTerms, InternalAggregation, InternalAvg, InternalBucketMetricValue, InternalCardinality, InternalChildren, InternalDateRange, InternalDerivative, InternalExtendedStats, InternalExtendedStatsBucket, InternalFilter, InternalFilters, InternalGeoBounds, InternalGeoCentroid, InternalGeoDistance, InternalGeoHashGrid, InternalGlobal, InternalHDRPercentileRanks, InternalHDRPercentiles, InternalHistogram, InternalIPv4Range, InternalMax, InternalMetricsAggregation, InternalMin, InternalMissing, InternalMultiBucketAggregation, InternalNested, InternalNumericMetricsAggregation, InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue, InternalPercentilesBucket, InternalRange, InternalReverseNested, InternalSampler, InternalScriptedMetric, InternalSignificantTerms, InternalSimpleValue, InternalSingleBucketAggregation, InternalStats, InternalStatsBucket, InternalSum, InternalTDigestPercentileRanks, InternalTDigestPercentiles, InternalTerms, InternalTopHits, InternalValueCount, LongTerms, SignificantLongTerms, SignificantStringTerms, StringTerms, UnmappedSampler, UnmappedSignificantTerms, UnmappedTerms

public interface Aggregation

An aggregation

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Object>	getMetaData() Get the optional byte array metadata that was set on the aggregation
String	getName()
Object	getProperty(String path) Get the value of specified path in the aggregation.

Method Detail

getName

String getName()

Returns:

The name of this aggregation.

getProperty

Object getProperty(String path)

Get the value of specified path in the aggregation.

Parameters:

path - the path to the property in the aggregation tree

Returns:

the value of the property

getMetaData

Map<String,Object> getMetaData()

Get the optional byte array metadata that was set on the aggregation