Package org.opensearch.client.opensearch._types.aggregations

Class GeoDistanceAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

org.opensearch.client.opensearch._types.aggregations.GeoDistanceAggregation

All Implemented Interfaces:

JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class GeoDistanceAggregation
extends BucketAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
GeoDistanceType	distanceType()	API name: distance_type
java.lang.String	field()	API name: field
static GeoDistanceAggregation	of(java.util.function.Function<GeoDistanceAggregation.Builder,ObjectBuilder<GeoDistanceAggregation>> fn)
GeoLocation	origin()	API name: origin
java.util.List<AggregationRange>	ranges()	API name: ranges
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupGeoDistanceAggregationDeserializer(ObjectDeserializer<GeoDistanceAggregation.Builder> op)
DistanceUnit	unit()	API name: unit

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceAggregation> _DESERIALIZER

Json deserializer for GeoDistanceAggregation

Method Detail

of

public static GeoDistanceAggregation of(java.util.function.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()

API name: distance_type

field

@Nullable
public final java.lang.String field()

API name: field

origin

@Nullable
public final GeoLocation origin()

API name: origin

ranges

public final java.util.List<AggregationRange> ranges()

API name: ranges

unit

@Nullable
public final DistanceUnit 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)