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

Class HistogramBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.HistogramBucket.Builder

All Implemented Interfaces:

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

Enclosing class:

HistogramBucket

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

Builder for HistogramBucket.

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
HistogramBucket	build()	Builds a HistogramBucket.
HistogramBucket.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final HistogramBucket.Builder	key(double value)	Required - API name: key
final HistogramBucket.Builder	keyAsString(String value)	API name: key_as_string
protected HistogramBucket.Builder	self()

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

Returns:

a new builder instance.

self

@Nonnull
protected HistogramBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<HistogramBucket.Builder>

key

@Nonnull
public final HistogramBucket.Builder key(double value)

Required - API name: key

keyAsString

@Nonnull
public final HistogramBucket.Builder keyAsString(@Nullable
 String value)

API name: key_as_string

build

@Nonnull
public HistogramBucket build()

Builds a HistogramBucket.

Specified by:

build in interface ObjectBuilder<HistogramBucket>

Throws:

NullPointerException - if some of the required fields are null.