Package co.elastic.clients.elasticsearch._types.aggregations

Class ScriptedMetricAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>

co.elastic.clients.elasticsearch._types.aggregations.ScriptedMetricAggregation.Builder

All Implemented Interfaces:

WithJson<ScriptedMetricAggregation.Builder>, ObjectBuilder<ScriptedMetricAggregation>

Enclosing class:

ScriptedMetricAggregation

public static class ScriptedMetricAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
implements ObjectBuilder<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(Script value)	Runs once on each shard after document collection is complete.
final ScriptedMetricAggregation.Builder	combineScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	Runs once on each shard after document collection is complete.
final ScriptedMetricAggregation.Builder	initScript(Script value)	Runs prior to any collection of documents.
final ScriptedMetricAggregation.Builder	initScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	Runs prior to any collection of documents.
final ScriptedMetricAggregation.Builder	mapScript(Script value)	Run once per document collected.
final ScriptedMetricAggregation.Builder	mapScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	Run once per document collected.
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(Script value)	Runs once on the coordinating node after all shards have returned their results.
final ScriptedMetricAggregation.Builder	reduceScript(Function<Script.Builder,ObjectBuilder<Script>> fn)	Runs once on the coordinating node after all shards have returned their results.
protected ScriptedMetricAggregation.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder

field, missing, missing, missing, missing, missing, missing, script, script

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

combineScript

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

Runs once on each shard after document collection is complete. Allows the aggregation to consolidate the state returned from each shard.

API name: combine_script

combineScript

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

Runs once on each shard after document collection is complete. Allows the aggregation to consolidate the state returned from each shard.

API name: combine_script

initScript

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

Runs prior to any collection of documents. Allows the aggregation to set up any initial state.

API name: init_script

initScript

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

Runs prior to any collection of documents. Allows the aggregation to set up any initial state.

API name: init_script

mapScript

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

Run once per document collected. If no combine_script is specified, the resulting state needs to be stored in the state object.

API name: map_script

mapScript

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

Run once per document collected. If no combine_script is specified, the resulting state needs to be stored in the state object.

API name: map_script

params

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 entries of map to params.

params

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

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

Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard.

API name: reduce_script

reduceScript

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

Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variable states, which is an array of the result of the combine_script on each shard.

API name: reduce_script

self

protected ScriptedMetricAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>

build

public ScriptedMetricAggregation build()

Builds a ScriptedMetricAggregation.

Specified by:

build in interface ObjectBuilder<ScriptedMetricAggregation>

Throws:

NullPointerException - if some of the required fields are null.