org.elasticsearch.search.aggregations.bucket.range

Interface Range

All Superinterfaces:

Aggregation, MultiBucketsAggregation

All Known Subinterfaces:

DateRange, GeoDistance, IPv4Range

All Known Implementing Classes:

InternalDateRange, InternalGeoDistance, InternalIPv4Range, InternalRange

public interface Range
extends MultiBucketsAggregation

A range aggregation. Defines multiple buckets, each associated with a pre-defined value range of a field, and where the value of that fields in all documents in each bucket fall in the bucket's range.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Range.Bucket A bucket associated with a specific range

Method Summary

Modifier and Type	Method and Description
Range.Bucket	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<? extends Range.Bucket>	getBuckets() Return the buckets of this range aggregation.

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

getName

Method Detail

getBuckets

Collection<? extends Range.Bucket> getBuckets()

Return the buckets of this range aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

Range.Bucket getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the requested bucket.

Returns:

The bucket