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

Class ScriptedMetricAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.ScriptedMetricAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

ScriptedMetricAggregation

public static class ScriptedMetricAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
implements CopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation>

Builder for ScriptedMetricAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScriptedMetricAggregation	build()	Builds a ScriptedMetricAggregation.
final ScriptedMetricAggregation.Builder	combineScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: combine_script
final ScriptedMetricAggregation.Builder	combineScript(Script value)	API name: combine_script
ScriptedMetricAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ScriptedMetricAggregation.Builder	initScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: init_script
final ScriptedMetricAggregation.Builder	initScript(Script value)	API name: init_script
final ScriptedMetricAggregation.Builder	mapScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: map_script
final ScriptedMetricAggregation.Builder	mapScript(Script value)	API name: map_script
final ScriptedMetricAggregation.Builder	params(String key, JsonData value)	A global object with script parameters for init, map and combine scripts.
final ScriptedMetricAggregation.Builder	params(Map<String,JsonData> map)	A global object with script parameters for init, map and combine scripts.
final ScriptedMetricAggregation.Builder	reduceScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	API name: reduce_script
final ScriptedMetricAggregation.Builder	reduceScript(Script value)	API name: reduce_script
protected ScriptedMetricAggregation.Builder	self()

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

field, missing, missing, script, script

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

Returns:

a new builder instance.

self

@Nonnull
protected ScriptedMetricAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>

combineScript

@Nonnull
public final ScriptedMetricAggregation.Builder combineScript(@Nullable
 Script value)

API name: combine_script

combineScript

@Nonnull
public final ScriptedMetricAggregation.Builder combineScript(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: combine_script

initScript

@Nonnull
public final ScriptedMetricAggregation.Builder initScript(@Nullable
 Script value)

API name: init_script

initScript

@Nonnull
public final ScriptedMetricAggregation.Builder initScript(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: init_script

mapScript

@Nonnull
public final ScriptedMetricAggregation.Builder mapScript(@Nullable
 Script value)

API name: map_script

mapScript

@Nonnull
public final ScriptedMetricAggregation.Builder mapScript(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: map_script

params

@Nonnull
public final ScriptedMetricAggregation.Builder params(Map<String,JsonData> map)

A global object with script parameters for init, map and combine scripts. It is shared between the scripts.

API name: params

Adds all elements of map to params.

params

@Nonnull
public final ScriptedMetricAggregation.Builder params(String key,
 JsonData value)

A global object with script parameters for init, map and combine scripts. It is shared between the scripts.

API name: params

Adds an entry to params.

reduceScript

@Nonnull
public final ScriptedMetricAggregation.Builder reduceScript(@Nullable
 Script value)

API name: reduce_script

reduceScript

@Nonnull
public final ScriptedMetricAggregation.Builder reduceScript(Function<Script.Builder,ObjectBuilder<Script>> fn)

API name: reduce_script

build

@Nonnull
public ScriptedMetricAggregation build()

Builds a ScriptedMetricAggregation.

Specified by:

build in interface ObjectBuilder<ScriptedMetricAggregation>

Throws:

NullPointerException - if some of the required fields are null.