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

Class GeoDistanceAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<GeoDistanceAggregation.Builder>

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

All Implemented Interfaces:

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.
GeoDistanceAggregation.Builder	distanceType(GeoDistanceType value)	API name: distance_type
GeoDistanceAggregation.Builder	field(java.lang.String value)	API name: field
GeoDistanceAggregation.Builder	origin(java.util.function.Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	API name: origin
GeoDistanceAggregation.Builder	origin(GeoLocation value)	API name: origin
GeoDistanceAggregation.Builder	ranges(java.util.function.Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	API name: ranges
GeoDistanceAggregation.Builder	ranges(java.util.List<AggregationRange> list)	API name: ranges
GeoDistanceAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	API name: ranges
protected GeoDistanceAggregation.Builder	self()
GeoDistanceAggregation.Builder	unit(DistanceUnit value)	API name: unit

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

distanceType

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

API name: distance_type

field

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

API name: field

origin

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

API name: origin

origin

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

API name: origin

ranges

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

API name: ranges

Adds all elements of list to ranges.

ranges

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

API name: ranges

Adds one or more values to ranges.

ranges

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

API name: ranges

Adds a value to ranges using a builder lambda.

unit

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

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:

java.lang.NullPointerException - if some of the required fields are null.