Package org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation.Bucket

All Superinterfaces:
HasAggregations, org.elasticsearch.common.xcontent.ToXContent
All Known Subinterfaces:
AdjacencyMatrix.Bucket, CompositeAggregation.Bucket, Filters.Bucket, GeoGrid.Bucket, Histogram.Bucket, Range.Bucket, RareTerms.Bucket, SignificantTerms.Bucket, Terms.Bucket
All Known Implementing Classes:
AbstractInternalTerms.AbstractTermsBucket, InternalAdjacencyMatrix.InternalBucket, InternalAutoDateHistogram.Bucket, InternalBinaryRange.Bucket, InternalComposite.InternalBucket, InternalDateHistogram.Bucket, InternalDateRange.Bucket, InternalFilters.InternalBucket, InternalGeoGridBucket, InternalGeoHashGridBucket, InternalGeoTileGridBucket, InternalHistogram.Bucket, InternalMultiBucketAggregation.InternalBucket, InternalRange.Bucket, InternalRareTerms.Bucket, InternalSignificantTerms.Bucket, InternalTerms.Bucket, InternalVariableWidthHistogram.Bucket, LongRareTerms.Bucket, LongTerms.Bucket, ParsedAdjacencyMatrix.ParsedBucket, ParsedAutoDateHistogram.ParsedBucket, ParsedBinaryRange.ParsedBucket, ParsedComposite.ParsedBucket, ParsedDateHistogram.ParsedBucket, ParsedDateRange.ParsedBucket, ParsedDoubleTerms.ParsedBucket, ParsedFilters.ParsedBucket, ParsedGeoDistance.ParsedBucket, ParsedGeoGridBucket, ParsedGeoHashGridBucket, ParsedGeoTileGridBucket, ParsedLongRareTerms.ParsedBucket, ParsedLongTerms.ParsedBucket, ParsedMultiBucketAggregation.ParsedBucket, ParsedRange.ParsedBucket, ParsedRareTerms.ParsedBucket, ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket, ParsedSignificantTerms.ParsedBucket, ParsedStringRareTerms.ParsedBucket, ParsedStringTerms.ParsedBucket, ParsedTerms.ParsedBucket, ParsedVariableWidthHistogram.ParsedBucket, SignificantStringTerms.Bucket, StringRareTerms.Bucket, StringTerms.Bucket, UnmappedRareTerms.Bucket, UnmappedSignificantTerms.Bucket, UnmappedTerms.Bucket
Enclosing interface:
MultiBucketsAggregation
public static interface MultiBucketsAggregation.Bucket extends HasAggregations, org.elasticsearch.common.xcontent.ToXContent
A bucket represents a criteria to which all documents that fall in it adhere to. It is also uniquely identified by a key, and can potentially hold sub-aggregations computed over all documents in it.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    Aggregations
    getAggregations()
     
    long
    getDocCount()
     
    Object
    getKey()
     
    String
    getKeyAsString()
     

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

    isFragment, toXContent

  • Method Details

    • getKey

      Object getKey()
      Returns:
      The key associated with the bucket

    • getKeyAsString

      String getKeyAsString()
      Returns:
      The key associated with the bucket as a string

    • getDocCount

      long getDocCount()
      Returns:
      The number of documents that fall within this bucket

    • getAggregations

      Aggregations getAggregations()
      Specified by:
      getAggregations in interface HasAggregations
      Returns:
      The sub-aggregations of this bucket