Class: ScriptedMetricAgg

ScriptedMetricAgg

Elastic metrics aggregation that executes map-reduce style scripts.

link

Constructor

new ScriptedMetricAgg(scripts)

Parameters:
Name Type Description
scripts Object

Scripts object containing map-reduce logic.

{ 'init_script': 'script', 'map_script':'script', 'combine_script':'script', 'reduce_script':'script' }

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object. Returns undefined if not set.

Overrides:
Source:
Returns:

Name of aggregation.

Type
string

setName(name)

Attach a name to the aggregation object. Can be used when attaching the aggregation to a query. Convenience method to allow responsibility of the name to be given to the creator of the aggregation object. Can be accessed directly but won't show up during serialization.

Parameters:
Name Type Description
name string

Name of aggregation.

Overrides:
Source:

ScriptedMetricAgg

Elastic metrics aggregation that executes map-reduce style scripts.

link

Constructor

new ScriptedMetricAgg(scripts)

Parameters:
Name Type Description
scripts Object

Scripts object containing map-reduce logic.

{ 'init_script': 'script', 'map_script':'script', 'combine_script':'script', 'reduce_script':'script' }

Source:

Extends

Methods

getName() → {string}

Get the name of the aggregation object. Returns undefined if not set.

Overrides:
Source:
Returns:

Name of aggregation.

Type
string

setName(name)

Attach a name to the aggregation object. Can be used when attaching the aggregation to a query. Convenience method to allow responsibility of the name to be given to the creator of the aggregation object. Can be accessed directly but won't show up during serialization.

Parameters:
Name Type Description
name string

Name of aggregation.

Overrides:
Source: