org.elasticsearch.search.aggregations.metrics.scripted

Class ScriptedMetricBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder<ScriptedMetricBuilder>

org.elasticsearch.search.aggregations.metrics.scripted.ScriptedMetricBuilder

All Implemented Interfaces:

ToXContent

public class ScriptedMetricBuilder
extends MetricsAggregationBuilder<ScriptedMetricBuilder>

Builder for the ScriptedMetric aggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ScriptedMetricBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptedMetricBuilder	combineScript(Script combineScript) Set the combine script.
ScriptedMetricBuilder	initScript(Script initScript) Set the init script.
protected void	internalXContent(XContentBuilder builder, ToXContent.Params builderParams)
ScriptedMetricBuilder	mapScript(Script mapScript) Set the map script.
ScriptedMetricBuilder	params(Map<String,Object> params) Set parameters that will be available in the init, map and combine phases.
ScriptedMetricBuilder	reduceScript(Script reduceScript) Set the reduce script.

Methods inherited from class org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder

setMetaData, toXContent

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptedMetricBuilder

public ScriptedMetricBuilder(String name)

Sole constructor.

Method Detail

initScript

public ScriptedMetricBuilder initScript(Script initScript)

Set the init script.

mapScript

public ScriptedMetricBuilder mapScript(Script mapScript)

Set the map script.

combineScript

public ScriptedMetricBuilder combineScript(Script combineScript)

Set the combine script.

reduceScript

public ScriptedMetricBuilder reduceScript(Script reduceScript)

Set the reduce script.

params

public ScriptedMetricBuilder params(Map<String,Object> params)

Set parameters that will be available in the init, map and combine phases.

internalXContent

protected void internalXContent(XContentBuilder builder,
                    ToXContent.Params builderParams)
                         throws IOException

Specified by:

internalXContent in class MetricsAggregationBuilder<ScriptedMetricBuilder>

Throws:

IOException