org.elasticsearch.search.aggregations.bucket.range.geodistance

Interface GeoDistance

All Superinterfaces:

Aggregation, MultiBucketsAggregation, Range

All Known Implementing Classes:

InternalGeoDistance

public interface GeoDistance
extends Range

An aggregation that computes ranges of geo distances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GeoDistance.Bucket A range bucket.

Method Summary

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

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

getName

Method Detail

getBuckets

Collection<? extends GeoDistance.Bucket> getBuckets()

Description copied from interface: Range

Return the buckets of this range aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Range

Returns:

The buckets of this aggregation.

getBucketByKey

GeoDistance.Bucket getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Specified by:

getBucketByKey in interface Range

Parameters:

key - The key of the requested bucket.

Returns:

The bucket