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

Class MultiTermsBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.MultiTermsBucket.Builder

All Implemented Interfaces:

ObjectBuilder<MultiTermsBucket>

Enclosing class:

MultiTermsBucket

public static class MultiTermsBucket.Builder
extends MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>
implements ObjectBuilder<MultiTermsBucket>

Builder for MultiTermsBucket.

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
MultiTermsBucket	build()	Builds a MultiTermsBucket.
MultiTermsBucket.Builder	docCountErrorUpperBound(java.lang.Long value)	API name: doc_count_error_upper_bound
MultiTermsBucket.Builder	key(java.lang.String value, java.lang.String... values)	Required - API name: key
MultiTermsBucket.Builder	key(java.util.List<java.lang.String> list)	Required - API name: key
MultiTermsBucket.Builder	keyAsString(java.lang.String value)	API name: key_as_string
protected MultiTermsBucket.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, _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 MultiTermsBucket.Builder key(java.util.List<java.lang.String> list)

Required - API name: key

Adds all elements of list to key.

key

public final MultiTermsBucket.Builder key(java.lang.String value,
                                          java.lang.String... values)

Required - API name: key

Adds one or more values to key.

keyAsString

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

API name: key_as_string

docCountErrorUpperBound

public final MultiTermsBucket.Builder docCountErrorUpperBound(@Nullable
                                                              java.lang.Long value)

API name: doc_count_error_upper_bound

self

protected MultiTermsBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>

build

public MultiTermsBucket build()

Builds a MultiTermsBucket.

Specified by:

build in interface ObjectBuilder<MultiTermsBucket>

Throws:

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