GeoDistanceAggregation (java-client 7.15.2 API)

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, UnionVariant

@JsonpDeserializable
public final 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 co.elastic.clients.elasticsearch._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
Constructor	Description
`GeoDistanceAggregation(GeoDistanceAggregation.Builder builder)`
`GeoDistanceAggregation(java.util.function.Function<GeoDistanceAggregation.Builder,GeoDistanceAggregation.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`_variantType()`	`Aggregation` variant type
`GeoDistanceType`	`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 void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupGeoDistanceAggregationDeserializer(DelegatingDeserializer<GeoDistanceAggregation.Builder> op)`
`DistanceUnit`	`unit()`	API name: `unit`

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

aggregations, setupBucketAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._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 co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<GeoDistanceAggregation> _DESERIALIZER
  
  Json deserializer for GeoDistanceAggregation
Constructor Details
- GeoDistanceAggregation
  
  public GeoDistanceAggregation(GeoDistanceAggregation.Builder builder)
- GeoDistanceAggregation
  
  public GeoDistanceAggregation(java.util.function.Function<GeoDistanceAggregation.Builder,GeoDistanceAggregation.Builder> fn)
Method Details
- _variantType
  
  public java.lang.String _variantType()
  
  Aggregation variant type
  
  Specified by:
  
  _variantType in interface UnionVariant
- distanceType
  
  @Nullable public GeoDistanceType 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 DistanceUnit unit()
  
  API name: unit
- serializeInternal
  
  protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Overrides:
  
  serializeInternal in class BucketAggregationBase
- setupGeoDistanceAggregationDeserializer
  
  protected static void setupGeoDistanceAggregationDeserializer(DelegatingDeserializer<GeoDistanceAggregation.Builder> op)