Interface Aggregation

All Superinterfaces:
ToXContent, ToXContentFragment
All Known Subinterfaces:
AdjacencyMatrix, Avg, BucketMetricValue, Cardinality, CompositeAggregation, Derivative, ExtendedStats, ExtendedStatsBucket, Filter, Filters, GeoBounds, GeoCentroid, GeoGrid, Global, Histogram, Max, MedianAbsoluteDeviation, Min, Missing, MultiBucketsAggregation, MultiValueAggregation, Nested, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue, PercentileRanks, Percentiles, PercentilesBucket, Range, RareTerms, ReverseNested, Sampler, ScriptedMetric, SignificantTerms, SimpleValue, SingleBucketAggregation, Stats, StatsBucket, Sum, Terms, TopHits, ValueCount, WeightedAvg
All Known Implementing Classes:
AbstractInternalTerms, DoubleTerms, InternalAdjacencyMatrix, InternalAggregation, InternalAutoDateHistogram, InternalAvg, InternalBinaryRange, InternalBucketMetricValue, InternalCardinality, InternalComposite, InternalDateHistogram, InternalDateRange, InternalDerivative, InternalExtendedStats, InternalExtendedStatsBucket, InternalFilter, InternalFilters, InternalGeoBounds, InternalGeoCentroid, InternalGeoDistance, InternalGeoGrid, InternalGeoHashGrid, InternalGeoTileGrid, InternalGlobal, InternalHDRPercentileRanks, InternalHDRPercentiles, InternalHistogram, InternalMappedRareTerms, InternalMappedSignificantTerms, InternalMappedTerms, InternalMax, InternalMedianAbsoluteDeviation, InternalMin, InternalMissing, InternalMultiBucketAggregation, InternalMultiValueAggregation, InternalNested, InternalNumericMetricsAggregation, InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue, InternalPercentilesBucket, InternalRange, InternalRareTerms, InternalReverseNested, InternalSampler, InternalScriptedMetric, InternalSignificantTerms, InternalSimpleValue, InternalSingleBucketAggregation, InternalStats, InternalStatsBucket, InternalSum, InternalTDigestPercentileRanks, InternalTDigestPercentiles, InternalTerms, InternalTopHits, InternalValueCount, InternalVariableWidthHistogram, InternalWeightedAvg, LongRareTerms, LongTerms, ParsedAdjacencyMatrix, ParsedAggregation, ParsedAutoDateHistogram, ParsedAvg, ParsedBinaryRange, ParsedBucketMetricValue, ParsedCardinality, ParsedComposite, ParsedDateHistogram, ParsedDateRange, ParsedDerivative, ParsedDoubleTerms, ParsedExtendedStats, ParsedExtendedStatsBucket, ParsedFilter, ParsedFilters, ParsedGeoBounds, ParsedGeoCentroid, ParsedGeoDistance, ParsedGeoGrid, ParsedGeoHashGrid, ParsedGeoTileGrid, ParsedGlobal, ParsedHDRPercentileRanks, ParsedHDRPercentiles, ParsedHistogram, ParsedLongRareTerms, ParsedLongTerms, ParsedMax, ParsedMedianAbsoluteDeviation, ParsedMin, ParsedMissing, ParsedMultiBucketAggregation, ParsedNested, ParsedPercentiles, ParsedPercentilesBucket, ParsedRange, ParsedRareTerms, ParsedReverseNested, ParsedSampler, ParsedScriptedMetric, ParsedSignificantLongTerms, ParsedSignificantStringTerms, ParsedSignificantTerms, ParsedSimpleValue, ParsedSingleBucketAggregation, ParsedSingleValueNumericMetricsAggregation, ParsedStats, ParsedStatsBucket, ParsedStringRareTerms, ParsedStringTerms, ParsedSum, ParsedTDigestPercentileRanks, ParsedTDigestPercentiles, ParsedTerms, ParsedTopHits, ParsedValueCount, ParsedVariableWidthHistogram, ParsedWeightedAvg, SignificantLongTerms, SignificantStringTerms, StringRareTerms, StringTerms, UnmappedRareTerms, UnmappedSampler, UnmappedSignificantTerms, UnmappedTerms

public interface Aggregation extends ToXContentFragment
An aggregation. Extends ToXContent as it makes it easier to print out its content.
  • Field Details

    • TYPED_KEYS_DELIMITER

      static final String TYPED_KEYS_DELIMITER
      Delimiter used when prefixing aggregation names with their type using the typed_keys parameter
      See Also:
  • Method Details

    • getName

      String getName()
      Returns:
      The name of this aggregation.
    • getType

      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

      Map<String,Object> getMetadata()
      Get the optional byte array metadata that was set on the aggregation