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

Class GeoDistanceAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceAggregation.Builder	addRanges(java.util.function.Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	Add a value to ranges(List), creating the list if needed.
GeoDistanceAggregation.Builder	addRanges(AggregationRange value)	Add a value to ranges(List), creating the list if needed.
GeoDistanceAggregation	build()	Builds a GeoDistanceAggregation.
GeoDistanceAggregation.Builder	distanceType(jakarta.json.JsonValue value)	API name: distance_type
GeoDistanceAggregation.Builder	field(java.lang.String value)	API name: field
GeoDistanceAggregation.Builder	origin(jakarta.json.JsonValue value)	API name: origin
GeoDistanceAggregation.Builder	ranges(java.util.function.Function<AggregationRange.Builder,ObjectBuilder<AggregationRange>> fn)	Set ranges(List) to a singleton list.
GeoDistanceAggregation.Builder	ranges(java.util.List<AggregationRange> value)	API name: ranges
GeoDistanceAggregation.Builder	ranges(AggregationRange... value)	API name: ranges
protected GeoDistanceAggregation.Builder	self()
GeoDistanceAggregation.Builder	unit(jakarta.json.JsonValue value)	API name: unit

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

aggregations, aggregations, putAggregations, putAggregations

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

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

distanceType

public GeoDistanceAggregation.Builder distanceType(@Nullable jakarta.json.JsonValue value)

API name: distance_type

field

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

API name: field

origin

public GeoDistanceAggregation.Builder origin(@Nullable jakarta.json.JsonValue value)

API name: origin

ranges

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

API name: ranges

ranges

public GeoDistanceAggregation.Builder ranges(AggregationRange... value)

API name: ranges

addRanges

public GeoDistanceAggregation.Builder addRanges(AggregationRange value)

Add a value to ranges(List), creating the list if needed.

ranges

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

Set ranges(List) to a singleton list.

addRanges

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

Add a value to ranges(List), creating the list if needed.

unit

public GeoDistanceAggregation.Builder unit(@Nullable jakarta.json.JsonValue value)

API name: unit

self

protected GeoDistanceAggregation.Builder self()

Specified by:

self in class Aggregation.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.