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 classGeoDistanceAggregation.BuilderBuilder forGeoDistanceAggregation.-
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>_DESERIALIZERJson deserializer forGeoDistanceAggregation
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Aggregation.Kind_aggregationKind()Aggregation variant kind.GeoDistanceTypedistanceType()API name:distance_typejava.lang.Stringfield()API name:fieldstatic GeoDistanceAggregationof(java.util.function.Function<GeoDistanceAggregation.Builder,ObjectBuilder<GeoDistanceAggregation>> fn)GeoLocationorigin()API name:originjava.util.List<AggregationRange>ranges()API name:rangesprotected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupGeoDistanceAggregationDeserializer(ObjectDeserializer<GeoDistanceAggregation.Builder> op)DistanceUnitunit()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 forGeoDistanceAggregation
-
-
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:
_aggregationKindin interfaceAggregationVariant
-
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:
serializeInternalin classAggregationBase
-
setupGeoDistanceAggregationDeserializer
protected static void setupGeoDistanceAggregationDeserializer(ObjectDeserializer<GeoDistanceAggregation.Builder> op)
-
-