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

Class CompositeAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<CompositeAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<CompositeAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.CompositeAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

CompositeAggregation

public static class CompositeAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<CompositeAggregation.Builder>
implements CopyableBuilder<CompositeAggregation.Builder,CompositeAggregation>

Builder for CompositeAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CompositeAggregation.Builder	after(String key, Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: after
final CompositeAggregation.Builder	after(String key, FieldValue value)	API name: after
final CompositeAggregation.Builder	after(Map<String,FieldValue> map)	API name: after
CompositeAggregation	build()	Builds a CompositeAggregation.
CompositeAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected CompositeAggregation.Builder	self()
final CompositeAggregation.Builder	size(Integer value)	The number of composite buckets that should be returned.
final CompositeAggregation.Builder	sources(List<Map<String,CompositeAggregationSource>> list)	The value sources used to build composite buckets.
final CompositeAggregation.Builder	sources(Map<String,CompositeAggregationSource> value, Map<String,CompositeAggregationSource>... values)	The value sources used to build composite buckets.

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

meta, meta, name

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

Returns:

a new builder instance.

self

@Nonnull
protected CompositeAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<CompositeAggregation.Builder>

after

@Nonnull
public final CompositeAggregation.Builder after(Map<String,FieldValue> map)

API name: after

Adds all elements of map to after.

after

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

API name: after

Adds an entry to after.

after

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

API name: after

Adds a value to after using a builder lambda.

size

@Nonnull
public final CompositeAggregation.Builder size(@Nullable
 Integer value)

The number of composite buckets that should be returned.

API name: size

sources

@Nonnull
public final CompositeAggregation.Builder sources(List<Map<String,CompositeAggregationSource>> list)

The value sources used to build composite buckets. Keys are returned in the order of the sources definition.

API name: sources

Adds all elements of list to sources.

sources

@Nonnull
public final CompositeAggregation.Builder sources(Map<String,CompositeAggregationSource> value,
 Map<String,CompositeAggregationSource>... values)

The value sources used to build composite buckets. Keys are returned in the order of the sources definition.

API name: sources

Adds one or more values to sources.

build

@Nonnull
public CompositeAggregation build()

Builds a CompositeAggregation.

Specified by:

build in interface ObjectBuilder<CompositeAggregation>

Throws:

NullPointerException - if some of the required fields are null.