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

Class StringTermsBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MultiBucketBase.AbstractBuilder<BuilderT>

org.opensearch.client.opensearch._types.aggregations.TermsBucketBase.AbstractBuilder<StringTermsBucket.Builder>

org.opensearch.client.opensearch._types.aggregations.StringTermsBucket.Builder

All Implemented Interfaces:

ObjectBuilder<StringTermsBucket>

Enclosing class:

StringTermsBucket

public static class StringTermsBucket.Builder
extends TermsBucketBase.AbstractBuilder<StringTermsBucket.Builder>
implements ObjectBuilder<StringTermsBucket>

Builder for StringTermsBucket.

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
StringTermsBucket	build()	Builds a StringTermsBucket.
StringTermsBucket.Builder	key(java.lang.String value)	Required - API name: key
protected StringTermsBucket.Builder	self()

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

docCountError

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, _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

key

public final StringTermsBucket.Builder key(java.lang.String value)

Required - API name: key

self

protected StringTermsBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<StringTermsBucket.Builder>

build

public StringTermsBucket build()

Builds a StringTermsBucket.

Specified by:

build in interface ObjectBuilder<StringTermsBucket>

Throws:

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