org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation.Bucket

All Superinterfaces:

HasAggregations

All Known Subinterfaces:

DateHistogram.Bucket, DateRange.Bucket, Filters.Bucket, GeoDistance.Bucket, GeoHashGrid.Bucket, Histogram.Bucket, IPv4Range.Bucket, Range.Bucket

All Known Implementing Classes:

InternalDateRange.Bucket, InternalFilters.Bucket, InternalHistogram.Bucket, InternalIPv4Range.Bucket, InternalRange.Bucket, InternalSignificantTerms.Bucket, InternalTerms.Bucket, SignificantStringTerms.Bucket, SignificantTerms.Bucket, StringTerms.Bucket, Terms.Bucket

Enclosing interface:

MultiBucketsAggregation

public static interface MultiBucketsAggregation.Bucket
extends HasAggregations

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

Modifier and Type	Interface and Description
static class	MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
String	getKey()
Text	getKeyAsText()

Method Detail

getKey

String getKey()

Returns:

The key associated with the bucket as a string

getKeyAsText

Text getKeyAsText()

Returns:

The key associated with the bucket as text (ideal for further streaming this instance)

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