org.elasticsearch.search.aggregations.bucket

Interface MultiBucketsAggregation

All Superinterfaces:

Aggregation

All Known Subinterfaces:

DateHistogram, DateRange, Filters, GeoDistance, GeoHashGrid, Histogram, IPv4Range, Range, SignificantTerms, Terms

All Known Implementing Classes:

DoubleTerms, InternalDateHistogram, InternalDateRange, InternalFilters, InternalGeoDistance, InternalGeoHashGrid, InternalHistogram, InternalIPv4Range, InternalRange, InternalSignificantTerms, InternalTerms, LongTerms, SignificantLongTerms, SignificantStringTerms, StringTerms, UnmappedSignificantTerms, UnmappedTerms

public interface MultiBucketsAggregation
extends Aggregation

An aggregation that returns multiple buckets

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MultiBucketsAggregation.Bucket A bucket represents a criteria to which all documents that fall in it adhere to.

Method Summary

Modifier and Type	Method and Description
<B extends MultiBucketsAggregation.Bucket> B	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<? extends MultiBucketsAggregation.Bucket>	getBuckets()

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getName

Method Detail

getBuckets

Collection<? extends MultiBucketsAggregation.Bucket> getBuckets()

Returns:

The buckets of this aggregation.

getBucketByKey

<B extends MultiBucketsAggregation.Bucket> B getBucketByKey(String key)

The bucket that is associated with the given key.

Parameters:

key - The key of the requested bucket.

Returns:

The bucket