Package co.elastic.clients.elasticsearch._types.aggregations

Class GeoDistanceAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.GeoDistanceAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class GeoDistanceAggregation
extends BucketAggregationBase
implements AggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GeoDistanceAggregation.Builder	Builder for GeoDistanceAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GeoDistanceAggregation>	_DESERIALIZER	Json deserializer for GeoDistanceAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final GeoDistanceType	distanceType()	The distance calculation type.
final String	field()	A field of type geo_point used to evaluate the distance.
static GeoDistanceAggregation	of(Function<GeoDistanceAggregation.Builder,ObjectBuilder<GeoDistanceAggregation>> fn)
final GeoLocation	origin()	The origin used to evaluate the distance.
final List<AggregationRange>	ranges()	An array of ranges used to bucket documents.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoDistanceAggregationDeserializer(ObjectDeserializer<GeoDistanceAggregation.Builder> op)
final DistanceUnit	unit()	The distance unit.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceAggregation> _DESERIALIZER

Json deserializer for GeoDistanceAggregation

Method Details

of

public static GeoDistanceAggregation of(Function<GeoDistanceAggregation.Builder,ObjectBuilder<GeoDistanceAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

distanceType

@Nullable
public final GeoDistanceType distanceType()

The distance calculation type.

API name: distance_type

field

@Nullable
public final String field()

A field of type geo_point used to evaluate the distance.

API name: field

origin

@Nullable
public final GeoLocation origin()

The origin used to evaluate the distance.

API name: origin

ranges

public final List<AggregationRange> ranges()

An array of ranges used to bucket documents.

API name: ranges

unit

@Nullable
public final DistanceUnit unit()

The distance unit.

API name: unit

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class AggregationBase

setupGeoDistanceAggregationDeserializer

protected static void setupGeoDistanceAggregationDeserializer(ObjectDeserializer<GeoDistanceAggregation.Builder> op)