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

Class GeoBoundsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<GeoBoundsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.GeoBoundsAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

GeoBoundsAggregation

public static class GeoBoundsAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<GeoBoundsAggregation.Builder>
implements CopyableBuilder<GeoBoundsAggregation.Builder,GeoBoundsAggregation>

Builder for GeoBoundsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GeoBoundsAggregation	build()	Builds a GeoBoundsAggregation.
GeoBoundsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected GeoBoundsAggregation.Builder	self()
final GeoBoundsAggregation.Builder	wrapLongitude(Boolean value)	Specifies whether the bounding box should be allowed to overlap the international date line.

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

field, missing, missing, script, script

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 GeoBoundsAggregation.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<GeoBoundsAggregation.Builder,GeoBoundsAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected GeoBoundsAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<GeoBoundsAggregation.Builder>

wrapLongitude

@Nonnull
public final GeoBoundsAggregation.Builder wrapLongitude(@Nullable
 Boolean value)

Specifies whether the bounding box should be allowed to overlap the international date line.

API name: wrap_longitude

build

@Nonnull
public GeoBoundsAggregation build()

Builds a GeoBoundsAggregation.

Specified by:

build in interface ObjectBuilder<GeoBoundsAggregation>

Throws:

NullPointerException - if some of the required fields are null.