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:

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

Enclosing class:

MultiTermsBucket

public static class MultiTermsBucket.Builder
extends MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>
implements CopyableBuilder<MultiTermsBucket.Builder,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	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MultiTermsBucket.Builder	docCountErrorUpperBound(Long value)	API name: doc_count_error_upper_bound
final MultiTermsBucket.Builder	key(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: key
final MultiTermsBucket.Builder	key(List<FieldValue> list)	Required - API name: key
final MultiTermsBucket.Builder	key(FieldValue value, FieldValue... values)	Required - API name: key
final MultiTermsBucket.Builder	keyAsString(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, _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 MultiTermsBucket.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<MultiTermsBucket.Builder,MultiTermsBucket>

Returns:

a new builder instance.

self

@Nonnull
protected MultiTermsBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<MultiTermsBucket.Builder>

docCountErrorUpperBound

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

API name: doc_count_error_upper_bound

key

@Nonnull
public final MultiTermsBucket.Builder key(List<FieldValue> list)

Required - API name: key

Adds all elements of list to key.

key

@Nonnull
public final MultiTermsBucket.Builder key(FieldValue value,
 FieldValue... values)

Required - API name: key

Adds one or more values to key.

key

@Nonnull
public final MultiTermsBucket.Builder key(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Required - API name: key

Adds a value to key using a builder lambda.

keyAsString

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

API name: key_as_string

build

@Nonnull
public MultiTermsBucket build()

Builds a MultiTermsBucket.

Specified by:

build in interface ObjectBuilder<MultiTermsBucket>

Throws:

NullPointerException - if some of the required fields are null.