org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation.Bucket

All Superinterfaces:

HasAggregations, Streamable, ToXContent

All Known Subinterfaces:

Filters.Bucket, GeoHashGrid.Bucket, Histogram.Bucket, Range.Bucket

All Known Implementing Classes:

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

Enclosing interface:

MultiBucketsAggregation

public static interface MultiBucketsAggregation.Bucket
extends HasAggregations, ToXContent, Streamable

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>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
Object	getKey()
String	getKeyAsString()
Object	getProperty(String containingAggName, List<String> path)

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

readFrom, writeTo

Method Detail

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

getProperty

Object getProperty(String containingAggName,
                   List<String> path)