Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class ScriptedMetricAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregationBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class ScriptedMetricAggregationBuilder
extends AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final ConstructingObjectParser<ScriptedMetricAggregationBuilder,String>	PARSER

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	ScriptedMetricAggregationBuilder(String name)
	ScriptedMetricAggregationBuilder(StreamInput in)	Read from a stream.
protected	ScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
Script	combineScript()	Get the combine script.
ScriptedMetricAggregationBuilder	combineScript(Script combineScript)	Set the combine script.
protected org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
Script	initScript()	Get the init script.
ScriptedMetricAggregationBuilder	initScript(Script initScript)	Set the init script.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params builderParams)
Script	mapScript()	Get the map script.
ScriptedMetricAggregationBuilder	mapScript(Script mapScript)	Set the map script.
Map<String,Object>	params()	Get parameters that will be available in the init, map and combine phases.
ScriptedMetricAggregationBuilder	params(Map<String,Object> params)	Set parameters that will be available in the init, map and combine phases.
Script	reduceScript()	Get the reduce script.
ScriptedMetricAggregationBuilder	reduceScript(Script reduceScript)	Set the reduce script.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
boolean	supportsSampling()	Does this aggregation support running with in a sampling context.

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER

public static final ConstructingObjectParser<ScriptedMetricAggregationBuilder,String> PARSER

Constructor Details

ScriptedMetricAggregationBuilder

public ScriptedMetricAggregationBuilder(String name)

ScriptedMetricAggregationBuilder

protected ScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

ScriptedMetricAggregationBuilder

public ScriptedMetricAggregationBuilder(StreamInput in)
                                 throws IOException

Read from a stream.

Throws:

IOException

Method Details

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

Throws:

IOException

supportsSampling

public boolean supportsSampling()

Description copied from class: AggregationBuilder

Does this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override the InternalAggregation.finalizeSampling(SamplingContext) and scales any values that require scaling.

Overrides:

supportsSampling in class AggregationBuilder

Returns:

does this aggregation builder support sampling

initScript

public ScriptedMetricAggregationBuilder initScript(Script initScript)

Set the init script.

initScript

public Script initScript()

Get the init script.

mapScript

public ScriptedMetricAggregationBuilder mapScript(Script mapScript)

Set the map script.

mapScript

public Script mapScript()

Get the map script.

combineScript

public ScriptedMetricAggregationBuilder combineScript(Script combineScript)

Set the combine script.

combineScript

public Script combineScript()

Get the combine script.

reduceScript

public ScriptedMetricAggregationBuilder reduceScript(Script reduceScript)

Set the reduce script.

reduceScript

public Script reduceScript()

Get the reduce script.

params

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

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

params

public Map<String,Object> params()

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

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doBuild

protected org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subfactoriesBuilder)
                                                                                         throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

Throws:

IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

Throws:

IOException

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>