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

Class CompositeAggregate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<CompositeAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.MultiBucketAggregateBase.AbstractBuilder<CompositeBucket,CompositeAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.CompositeAggregate.Builder

All Implemented Interfaces:

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

Enclosing class:

CompositeAggregate

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

Builder for CompositeAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CompositeAggregate.Builder	afterKey(String key, Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: after_key
final CompositeAggregate.Builder	afterKey(String key, FieldValue value)	API name: after_key
final CompositeAggregate.Builder	afterKey(Map<String,FieldValue> map)	API name: after_key
CompositeAggregate	build()	Builds a CompositeAggregate.
CompositeAggregate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected CompositeAggregate.Builder	self()

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

buckets, buckets

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

meta, meta

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 CompositeAggregate.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<CompositeAggregate.Builder,CompositeAggregate>

Returns:

a new builder instance.

self

@Nonnull
protected CompositeAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<CompositeAggregate.Builder>

afterKey

@Nonnull
public final CompositeAggregate.Builder afterKey(Map<String,FieldValue> map)

API name: after_key

Adds all elements of map to afterKey.

afterKey

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

API name: after_key

Adds an entry to afterKey.

afterKey

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

API name: after_key

Adds a value to afterKey using a builder lambda.

build

@Nonnull
public CompositeAggregate build()

Builds a CompositeAggregate.

Specified by:

build in interface ObjectBuilder<CompositeAggregate>

Throws:

NullPointerException - if some of the required fields are null.