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<GeoDistanceAggregation.Builder>

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

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

All Implemented Interfaces:

CopyableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>, MutableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>, ObjectBuilder<GeoDistanceAggregation>

Enclosing class:

GeoDistanceAggregation

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

Builder for GeoDistanceAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoDistanceAggregation	build()	Builds a GeoDistanceAggregation.
GeoDistanceAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GeoDistanceAggregation.Builder	distanceType(GeoDistanceType value)	API name: distance_type
final GeoDistanceAggregation.Builder	field(String value)	API name: field
final GeoDistanceAggregation.Builder	origin(Function<GeoLocation.Builder,ObjectBuilder<GeoLocation>> fn)	API name: origin
final GeoDistanceAggregation.Builder	origin(GeoLocation value)	API name: origin
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.
final GeoDistanceAggregation.Builder	ranges(AggregationRange value, AggregationRange... values)	An array of ranges used to bucket documents.
protected GeoDistanceAggregation.Builder	self()
final 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, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GeoDistanceAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GeoDistanceAggregation.Builder,GeoDistanceAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected GeoDistanceAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<GeoDistanceAggregation.Builder>

distanceType

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

API name: distance_type

field

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

API name: field

origin

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

API name: origin

origin

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

API name: origin

ranges

@Nonnull
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

@Nonnull
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

@Nonnull
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

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

API name: unit

build

@Nonnull
public GeoDistanceAggregation build()

Builds a GeoDistanceAggregation.

Specified by:

build in interface ObjectBuilder<GeoDistanceAggregation>

Throws:

NullPointerException - if some of the required fields are null.