Package co.elastic.clients.elasticsearch._types.aggregations

Class GeoDistanceAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<GeoDistanceAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.GeoDistanceAggregation.Builder

All Implemented Interfaces:

WithJson<GeoDistanceAggregation.Builder>, ObjectBuilder<GeoDistanceAggregation>

Enclosing class:

GeoDistanceAggregation

public static class GeoDistanceAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<GeoDistanceAggregation.Builder>
implements ObjectBuilder<GeoDistanceAggregation>

Builder for GeoDistanceAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceAggregation	build()	Builds a GeoDistanceAggregation.
final GeoDistanceAggregation.Builder	distanceType(GeoDistanceType value)	The distance calculation type.
final GeoDistanceAggregation.Builder	field(String value)	A field of type geo_point used to evaluate the distance.
final GeoDistanceAggregation.Builder	origin(GeoLocation value)	The origin used to evaluate the distance.
final GeoDistanceAggregation.Builder	origin(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	The origin used to evaluate the distance.
final GeoDistanceAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	An array of ranges used to bucket documents.
final GeoDistanceAggregation.Builder	ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	An array of ranges used to bucket documents.
final GeoDistanceAggregation.Builder	ranges(List<AggregationRange> list)	An array of ranges used to bucket documents.
protected GeoDistanceAggregation.Builder	self()
final GeoDistanceAggregation.Builder	unit(DistanceUnit value)	The distance unit.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

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.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

distanceType

public final GeoDistanceAggregation.Builder distanceType(@Nullable
 GeoDistanceType value)

The distance calculation type.

API name: distance_type

field

public final GeoDistanceAggregation.Builder field(@Nullable
 String value)

A field of type geo_point used to evaluate the distance.

API name: field

origin

public final GeoDistanceAggregation.Builder origin(@Nullable
 GeoLocation value)

The origin used to evaluate the distance.

API name: origin

origin

public final GeoDistanceAggregation.Builder origin(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)

The origin used to evaluate the distance.

API name: origin

ranges

public final GeoDistanceAggregation.Builder ranges(List<AggregationRange> list)

An array of ranges used to bucket documents.

API name: ranges

Adds all elements of list to ranges.

ranges

public final GeoDistanceAggregation.Builder ranges(AggregationRange value,
 AggregationRange... values)

An array of ranges used to bucket documents.

API name: ranges

Adds one or more values to ranges.

ranges

public final GeoDistanceAggregation.Builder ranges(Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)

An array of ranges used to bucket documents.

API name: ranges

Adds a value to ranges using a builder lambda.

unit

public final GeoDistanceAggregation.Builder unit(@Nullable
 DistanceUnit value)

The distance unit.

API name: unit

self

protected GeoDistanceAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeoDistanceAggregation.Builder>

build

public GeoDistanceAggregation build()

Builds a GeoDistanceAggregation.

Specified by:

build in interface ObjectBuilder<GeoDistanceAggregation>

Throws:

NullPointerException - if some of the required fields are null.