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:

ObjectBuilder<HistogramBucket>

Enclosing class:

HistogramBucket

public static class HistogramBucket.Builder
extends MultiBucketBase.AbstractBuilder<HistogramBucket.Builder>
implements ObjectBuilder<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	key(double value)	Required - API name: key
HistogramBucket.Builder	keyAsString(java.lang.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, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

keyAsString

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

API name: key_as_string

key

public final HistogramBucket.Builder key(double value)

Required - API name: key

self

protected HistogramBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<HistogramBucket.Builder>

build

public HistogramBucket build()

Builds a HistogramBucket.

Specified by:

build in interface ObjectBuilder<HistogramBucket>

Throws:

java.lang.NullPointerException - if some of the required fields are null.