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<StringTermsBucket.Builder>

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

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

All Implemented Interfaces:

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

Enclosing class:

StringTermsBucket

public static class StringTermsBucket.Builder
extends TermsBucketBase.AbstractBuilder<StringTermsBucket.Builder>
implements CopyableBuilder<StringTermsBucket.Builder,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	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final StringTermsBucket.Builder	key(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, _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 StringTermsBucket.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<StringTermsBucket.Builder,StringTermsBucket>

Returns:

a new builder instance.

self

@Nonnull
protected StringTermsBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<StringTermsBucket.Builder>

key

@Nonnull
public final StringTermsBucket.Builder key(String value)

Required - API name: key

build

@Nonnull
public StringTermsBucket build()

Builds a StringTermsBucket.

Specified by:

build in interface ObjectBuilder<StringTermsBucket>

Throws:

NullPointerException - if some of the required fields are null.