org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation.Bucket

All Superinterfaces:

HasAggregations, ToXContent

All Known Subinterfaces:

AdjacencyMatrix.Bucket, CompositeAggregation.Bucket, Filters.Bucket, GeoHashGrid.Bucket, Histogram.Bucket, Range.Bucket, SignificantTerms.Bucket, Terms.Bucket

All Known Implementing Classes:

InternalAdjacencyMatrix.InternalBucket, InternalBinaryRange.Bucket, InternalDateHistogram.Bucket, InternalDateRange.Bucket, InternalFilters.InternalBucket, InternalHistogram.Bucket, InternalMultiBucketAggregation.InternalBucket, InternalRange.Bucket, InternalSignificantTerms.Bucket, InternalTerms.Bucket, LongTerms.Bucket, ParsedAdjacencyMatrix.ParsedBucket, ParsedBinaryRange.ParsedBucket, ParsedComposite.ParsedBucket, ParsedDateHistogram.ParsedBucket, ParsedDateRange.ParsedBucket, ParsedDoubleTerms.ParsedBucket, ParsedFilters.ParsedBucket, ParsedGeoDistance.ParsedBucket, ParsedGeoHashGrid.ParsedBucket, ParsedLongTerms.ParsedBucket, ParsedMultiBucketAggregation.ParsedBucket, ParsedRange.ParsedBucket, ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket, ParsedSignificantTerms.ParsedBucket, ParsedStringTerms.ParsedBucket, ParsedTerms.ParsedBucket, SignificantStringTerms.Bucket, StringTerms.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.

Nested Class Summary

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()
java.lang.Object	getKey()
java.lang.String	getKeyAsString()

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

isFragment, toXContent

Method Detail

getKey

java.lang.Object getKey()

Returns:

The key associated with the bucket

getKeyAsString

java.lang.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