Module org.elasticsearch.server
Interface MultiBucketsAggregation.Bucket
- All Superinterfaces:
HasAggregations
- All Known Subinterfaces:
CompositeAggregation.Bucket,Filters.Bucket,GeoGrid.Bucket,IpPrefix.Bucket,Range.Bucket,RareTerms.Bucket,SignificantTerms.Bucket,Terms.Bucket
- All Known Implementing Classes:
AbstractHistogramBucket,AbstractInternalTerms.AbstractTermsBucket,DoubleTerms.Bucket,InternalBinaryRange.Bucket,InternalComposite.InternalBucket,InternalDateHistogram.Bucket,InternalDateRange.Bucket,InternalFilters.InternalBucket,InternalGeoGridBucket,InternalGeoHashGridBucket,InternalGeoTileGridBucket,InternalHistogram.Bucket,InternalIpPrefix.Bucket,InternalMultiBucketAggregation.InternalBucket,InternalMultiBucketAggregation.InternalBucketWritable,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
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 Summary
-
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:
getAggregationsin interfaceHasAggregations- Returns:
- The sub-aggregations of this bucket
-