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

Class RangeBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder<RangeBucket.Builder>

org.opensearch.client.opensearch._types.aggregations.RangeBucket.Builder

All Implemented Interfaces:

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

Enclosing class:

RangeBucket

public static class RangeBucket.Builder
extends MultiBucketBase.AbstractBuilder<RangeBucket.Builder>
implements CopyableBuilder<RangeBucket.Builder,RangeBucket>

Builder for RangeBucket.

Field Summary

Fields inherited from class org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder

aggregations

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RangeBucket	build()	Builds a RangeBucket.
RangeBucket.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final RangeBucket.Builder	from(Double value)	API name: from
final RangeBucket.Builder	fromAsString(String value)	API name: from_as_string
final RangeBucket.Builder	key(String value)	The bucket key.
protected RangeBucket.Builder	self()
final RangeBucket.Builder	to(Double value)	API name: to
final RangeBucket.Builder	toAsString(String value)	API name: to_as_string

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

aggregations, aggregations, aggregations, docCount

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

Returns:

a new builder instance.

self

@Nonnull
protected RangeBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<RangeBucket.Builder>

from

@Nonnull
public final RangeBucket.Builder from(@Nullable
 Double value)

API name: from

fromAsString

@Nonnull
public final RangeBucket.Builder fromAsString(@Nullable
 String value)

API name: from_as_string

key

@Nonnull
public final RangeBucket.Builder key(@Nullable
 String value)

The bucket key. Present if the aggregation is not keyed.

API name: key

to

@Nonnull
public final RangeBucket.Builder to(@Nullable
 Double value)

API name: to

toAsString

@Nonnull
public final RangeBucket.Builder toAsString(@Nullable
 String value)

API name: to_as_string

build

@Nonnull
public RangeBucket build()

Builds a RangeBucket.

Specified by:

build in interface ObjectBuilder<RangeBucket>

Throws:

NullPointerException - if some of the required fields are null.