Module org.elasticsearch.server
Package org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation.Bucket

All Superinterfaces:
HasAggregations, ToXContent
All Known Subinterfaces:
CompositeAggregation.Bucket, Filters.Bucket, GeoGrid.Bucket, Histogram.Bucket, IpPrefix.Bucket, Range.Bucket, RareTerms.Bucket, SignificantTerms.Bucket, Terms.Bucket
All Known Implementing Classes:
AbstractInternalTerms.AbstractTermsBucket, DoubleTerms.Bucket, InternalBinaryRange.Bucket, InternalComposite.InternalBucket, InternalDateHistogram.Bucket, InternalDateRange.Bucket, InternalFilters.InternalBucket, InternalGeoGridBucket, InternalGeoHashGridBucket, InternalGeoTileGridBucket, InternalHistogram.Bucket, InternalIpPrefix.Bucket, InternalMultiBucketAggregation.InternalBucket, InternalRange.Bucket, InternalRareTerms.Bucket, InternalSignificantTerms.Bucket, InternalTerms.Bucket, InternalVariableWidthHistogram.Bucket, LongRareTerms.Bucket, LongTerms.Bucket, SignificantLongTerms.Bucket, SignificantStringTerms.Bucket, StringRareTerms.Bucket, StringTerms.Bucket, UnmappedRareTerms.Bucket, UnmappedSignificantTerms.Bucket, UnmappedTerms.Bucket
Enclosing interface:
MultiBucketsAggregation
public static interface MultiBucketsAggregation.Bucket extends HasAggregations, 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.

  • 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

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