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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aScriptedMetricAggregation
.combineScript
(Script value) Runs once on each shard after document collection is complete.Runs once on each shard after document collection is complete.initScript
(Script value) Runs prior to any collection of documents.Runs prior to any collection of documents.Run once per document collected.Run once per document collected.A global object with script parameters forinit
,map
andcombine
scripts.A global object with script parameters forinit
,map
andcombine
scripts.reduceScript
(Script value) Runs once on the coordinating node after all shards have returned their results.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
combineScript
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
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
Run once per document collected. If nocombine_script
is specified, the resulting state needs to be stored in thestate
object.API name:
map_script
-
mapScript
public final ScriptedMetricAggregation.Builder mapScript(Function<Script.Builder, ObjectBuilder<Script>> fn) Run once per document collected. If nocombine_script
is specified, the resulting state needs to be stored in thestate
object.API name:
map_script
-
params
A global object with script parameters forinit
,map
andcombine
scripts. It is shared between the scripts.API name:
params
Adds all entries of
map
toparams
. -
params
A global object with script parameters forinit
,map
andcombine
scripts. It is shared between the scripts.API name:
params
Adds an entry to
params
. -
reduceScript
Runs once on the coordinating node after all shards have returned their results. The script is provided with access to a variablestates
, which is an array of the result of thecombine_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 variablestates
, which is an array of the result of thecombine_script
on each shard.API name:
reduce_script
-
self
- Specified by:
self
in classMetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
-
build
Builds aScriptedMetricAggregation
.- Specified by:
build
in interfaceObjectBuilder<ScriptedMetricAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-