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

Class GeoDistanceAggregate

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregateBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase<RangeBucket>

org.opensearch.client.opensearch._types.aggregations.RangeAggregate

org.opensearch.client.opensearch._types.aggregations.GeoDistanceAggregate

All Implemented Interfaces:

JsonpSerializable, AggregateVariant

@JsonpDeserializable
public class GeoDistanceAggregate
extends RangeAggregate
implements AggregateVariant

Result of a geo_distance aggregation. The unit for from and to is meters by default.

Nested Class Summary

Nested Classes

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

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

RangeAggregate.AbstractBuilder<BuilderT extends RangeAggregate.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregate.Kind	_aggregateKind()	Aggregate variant kind.
static GeoDistanceAggregate	of(java.util.function.Function<GeoDistanceAggregate.Builder,ObjectBuilder<GeoDistanceAggregate>> fn)
protected static void	setupGeoDistanceAggregateDeserializer(ObjectDeserializer<GeoDistanceAggregate.Builder> op)

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

rangeAggregateOf, setupRangeAggregateDeserializer

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

buckets, serializeInternal, setupMultiBucketAggregateBaseDeserializer

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

meta, serialize, setupAggregateBaseDeserializer

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.AggregateVariant

_toAggregate

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<GeoDistanceAggregate> _DESERIALIZER

Json deserializer for GeoDistanceAggregate

Method Detail

of

public static GeoDistanceAggregate of(java.util.function.Function<GeoDistanceAggregate.Builder,ObjectBuilder<GeoDistanceAggregate>> fn)

_aggregateKind

public Aggregate.Kind _aggregateKind()

Aggregate variant kind.

Specified by:

_aggregateKind in interface AggregateVariant

Overrides:

_aggregateKind in class RangeAggregate

setupGeoDistanceAggregateDeserializer

protected static void setupGeoDistanceAggregateDeserializer(ObjectDeserializer<GeoDistanceAggregate.Builder> op)