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, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class GeoDistanceAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>

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 final JsonpDeserializer<GeoDistanceAggregation>	_DESERIALIZER	Json deserializer for GeoDistanceAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static GeoDistanceAggregation.Builder	builder()
final GeoDistanceType	distanceType()	API name: distance_type
boolean	equals(Object o)
final String	field()	API name: field
int	hashCode()
static GeoDistanceAggregation	of(Function<GeoDistanceAggregation.Builder,ObjectBuilder<GeoDistanceAggregation>> fn)
final GeoLocation	origin()	API name: origin
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)
GeoDistanceAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final 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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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()

API name: distance_type

field

@Nullable
public final String field()

API name: field

origin

@Nullable
public final GeoLocation origin()

API name: origin

ranges

@Nonnull
public final List<AggregationRange> ranges()

An array of ranges used to bucket documents.

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

toBuilder

@Nonnull
public GeoDistanceAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static GeoDistanceAggregation.Builder builder()

setupGeoDistanceAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase