com.arakelian.elastic.model.aggs.bucket

Interface GeoDistanceAggregation

All Superinterfaces:

Aggregation, BucketAggregation, java.io.Serializable

@Value.Immutable(copy=false)
public interface GeoDistanceAggregation
extends BucketAggregation

A multi-bucket aggregation that works on geo_point fields and conceptually works very similar to the range aggregation.

The user can define a point of origin and a set of distance range buckets. The aggregation evaluate the distance of each document value from the origin point and determines the buckets it belongs to based on the ranges (a document belongs to a bucket if the distance between the document and the origin falls within the distance range of the bucket).

See Also:

Geo Distance Aggregation, GeoDistanceAggregationBuilder.java

Field Summary

Fields inherited from interface com.arakelian.elastic.model.aggs.Aggregation

ADJACENCY_MATRIX_AGGREGATION, AVG_AGGREGATION, CARDINALITY_AGGREGATION, DATE_HISTOGRAM_AGGREGATION, DATE_RANGE_AGGREGATION, EXTENDED_STATS_AGGREGATION, FILTER_AGGREGATION, FILTERS_AGGREGATION, GEO_BOUNDS_AGGREGATION, GEO_CENTROID_AGGREGATION, GEO_DISTANCE_AGGREGATION, GEOHASH_GRID_AGGREGATION, GLOBAL_AGGREGATION, HISTOGRAM_AGGREGATION, IP_RANGE_AGGREGATION, MAX_AGGREGATION, MIN_AGGREGATION, MISSING_AGGREGATION, NESTED_AGGREGATION, PERCENTILE_RANKS_AGGREGATION, PERCENTILES_AGGREGATION, RANGE_AGGREGATION, REVERSE_NESTED_AGGREGATION, SAMPLER_AGGREGATION, SIGNIFICANT_TERMS_AGGREGATION, SIGNIFICANT_TEXT_AGGREGATION, STATS_AGGREGATION, SUM_AGGREGATION, TERMS_AGGREGATION, VALUE_COUNT_AGGREGATION

Method Summary

Modifier and Type	Method and Description
default void	accept(AggregationVisitor visitor)
DistanceType	getDistanceType()
com.arakelian.jackson.model.GeoPoint	getOrigin()
default java.util.List<Range>	getRanges()
Unit	getUnit()
java.lang.Boolean	isKeyed()

Methods inherited from interface com.arakelian.elastic.model.aggs.Aggregation

countNotEmpty, getName, getSubAggregations, isEmpty

Method Detail

getDistanceType

DistanceType getDistanceType()

getOrigin

com.arakelian.jackson.model.GeoPoint getOrigin()

getRanges

@Value.Default
default java.util.List<Range> getRanges()

getUnit

Unit getUnit()

isKeyed

java.lang.Boolean isKeyed()

accept

default void accept(AggregationVisitor visitor)

Specified by:

accept in interface Aggregation