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

Class GeoDistanceAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation

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

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

All Implemented Interfaces:

ToJsonp

public final class GeoDistanceAggregation
extends BucketAggregationBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GeoDistanceAggregation(GeoDistanceAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
jakarta.json.JsonValue	distanceType()	API name: distance_type
java.lang.String	field()	API name: field
jakarta.json.JsonValue	origin()	API name: origin
java.util.List<AggregationRange>	ranges()	API name: ranges
protected static void	setupGeoDistanceAggregationDeserializer(DelegatingDeserializer<GeoDistanceAggregation.Builder> op)
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
jakarta.json.JsonValue	unit()	API name: unit

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

aggregations, setupBucketAggregationBaseDeserializer

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

meta, name, setupAggregationDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<GeoDistanceAggregation> DESERIALIZER

Json deserializer for GeoDistanceAggregation

Constructor Details

GeoDistanceAggregation

protected GeoDistanceAggregation(GeoDistanceAggregation.Builder builder)

Method Details

distanceType

@Nullable public jakarta.json.JsonValue distanceType()

API name: distance_type

field

@Nullable public java.lang.String field()

API name: field

origin

@Nullable public jakarta.json.JsonValue origin()

API name: origin

ranges

@Nullable public java.util.List<AggregationRange> ranges()

API name: ranges

unit

@Nullable public jakarta.json.JsonValue unit()

API name: unit

toJsonpInternal

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

Overrides:

toJsonpInternal in class BucketAggregationBase

setupGeoDistanceAggregationDeserializer

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