Interface Aggregation
-
- All Superinterfaces:
ToXContent
,ToXContentFragment
- All Known Subinterfaces:
AdjacencyMatrix
,Avg
,BucketMetricValue
,Cardinality
,CompositeAggregation
,Derivative
,ExtendedStats
,ExtendedStatsBucket
,Filter
,Filters
,GeoBounds
,GeoCentroid
,GeoHashGrid
,Global
,Histogram
,Max
,MedianAbsoluteDeviation
,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
,WeightedAvg
- All Known Implementing Classes:
DoubleTerms
,InternalAdjacencyMatrix
,InternalAggregation
,InternalAutoDateHistogram
,InternalAvg
,InternalBinaryRange
,InternalBucketMetricValue
,InternalCardinality
,InternalComposite
,InternalDateHistogram
,InternalDateRange
,InternalDerivative
,InternalExtendedStats
,InternalExtendedStatsBucket
,InternalFilter
,InternalFilters
,InternalGeoBounds
,InternalGeoCentroid
,InternalGeoDistance
,InternalGeoHashGrid
,InternalGlobal
,InternalHDRPercentileRanks
,InternalHDRPercentiles
,InternalHistogram
,InternalMappedSignificantTerms
,InternalMappedTerms
,InternalMax
,InternalMedianAbsoluteDeviation
,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
,InternalWeightedAvg
,LongTerms
,ParsedAdjacencyMatrix
,ParsedAggregation
,ParsedAutoDateHistogram
,ParsedAvg
,ParsedBinaryRange
,ParsedBucketMetricValue
,ParsedCardinality
,ParsedComposite
,ParsedDateHistogram
,ParsedDateRange
,ParsedDerivative
,ParsedDoubleTerms
,ParsedExtendedStats
,ParsedExtendedStatsBucket
,ParsedFilter
,ParsedFilters
,ParsedGeoBounds
,ParsedGeoCentroid
,ParsedGeoDistance
,ParsedGeoHashGrid
,ParsedGlobal
,ParsedHDRPercentileRanks
,ParsedHDRPercentiles
,ParsedHistogram
,ParsedLongTerms
,ParsedMax
,ParsedMedianAbsoluteDeviation
,ParsedMin
,ParsedMissing
,ParsedMultiBucketAggregation
,ParsedNested
,ParsedPercentileRanks
,ParsedPercentiles
,ParsedPercentilesBucket
,ParsedRange
,ParsedReverseNested
,ParsedSampler
,ParsedScriptedMetric
,ParsedSignificantLongTerms
,ParsedSignificantStringTerms
,ParsedSignificantTerms
,ParsedSimpleValue
,ParsedSingleBucketAggregation
,ParsedSingleValueNumericMetricsAggregation
,ParsedStats
,ParsedStatsBucket
,ParsedStringTerms
,ParsedSum
,ParsedTDigestPercentileRanks
,ParsedTDigestPercentiles
,ParsedTerms
,ParsedTopHits
,ParsedValueCount
,ParsedWeightedAvg
,SignificantLongTerms
,SignificantStringTerms
,StringTerms
,UnmappedSampler
,UnmappedSignificantTerms
,UnmappedTerms
public interface Aggregation extends ToXContentFragment
An aggregation. ExtendsToXContent
as it makes it easier to print out its content.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Aggregation.CommonFields
Common xcontent fields that are shared among addAggregation-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPED_KEYS_DELIMITER
Delimiter used when prefixing aggregation names with their type using the typed_keys parameter-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>
getMetaData()
Get the optional byte array metadata that was set on the aggregationjava.lang.String
getName()
java.lang.String
getType()
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
TYPED_KEYS_DELIMITER
static final java.lang.String TYPED_KEYS_DELIMITER
Delimiter used when prefixing aggregation names with their type using the typed_keys parameter- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
- Returns:
- The name of this aggregation.
-
getType
java.lang.String getType()
- Returns:
- a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.
-
getMetaData
java.util.Map<java.lang.String,java.lang.Object> getMetaData()
Get the optional byte array metadata that was set on the aggregation
-
-