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

Class CompositeBucket.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.CompositeBucket.Builder

All Implemented Interfaces:

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

Enclosing class:

CompositeBucket

public static class CompositeBucket.Builder
extends MultiBucketBase.AbstractBuilder<CompositeBucket.Builder>
implements CopyableBuilder<CompositeBucket.Builder,CompositeBucket>

Builder for CompositeBucket.

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
CompositeBucket	build()	Builds a CompositeBucket.
CompositeBucket.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompositeBucket.Builder	key(String key, Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: key
final CompositeBucket.Builder	key(String key, FieldValue value)	Required - API name: key
final CompositeBucket.Builder	key(Map<String,FieldValue> map)	Required - API name: key
protected CompositeBucket.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 CompositeBucket.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<CompositeBucket.Builder,CompositeBucket>

Returns:

a new builder instance.

self

@Nonnull
protected CompositeBucket.Builder self()

Specified by:

self in class MultiBucketBase.AbstractBuilder<CompositeBucket.Builder>

key

@Nonnull
public final CompositeBucket.Builder key(Map<String,FieldValue> map)

Required - API name: key

Adds all elements of map to key.

key

@Nonnull
public final CompositeBucket.Builder key(String key,
 FieldValue value)

Required - API name: key

Adds an entry to key.

key

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

Required - API name: key

Adds a value to key using a builder lambda.

build

@Nonnull
public CompositeBucket build()

Builds a CompositeBucket.

Specified by:

build in interface ObjectBuilder<CompositeBucket>

Throws:

NullPointerException - if some of the required fields are null.