Package org.opensearch.search.aggregations.pipeline

Class MovFnPipelineAggregator

java.lang.Object

org.opensearch.search.aggregations.pipeline.PipelineAggregator

org.opensearch.search.aggregations.pipeline.MovFnPipelineAggregator

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable

public class MovFnPipelineAggregator
extends PipelineAggregator

This pipeline aggregation gives the user the ability to script functions that "move" across a window of data, instead of single data points. It is the scripted version of MovingAvg pipeline agg.

Through custom script contexts, we expose a number of convenience methods:

• max
• min
• sum
• unweightedAvg
• linearWeightedAvg
• ewma
• holt
• holtWintersMovAvg

The user can also define any arbitrary logic via their own scripting, or combine with the above methods.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.pipeline.PipelineAggregator

PipelineAggregator.Parser, PipelineAggregator.PipelineTree

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
MovFnPipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)	Write the body of the aggregation to the wire.
String	getWriteableName()	The name of the writeable object.
InternalAggregation	reduce(InternalAggregation aggregation, InternalAggregation.ReduceContext reduceContext)

Methods inherited from class org.opensearch.search.aggregations.pipeline.PipelineAggregator

bucketsPaths, metadata, name, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

MovFnPipelineAggregator

public MovFnPipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Description copied from class: PipelineAggregator

Write the body of the aggregation to the wire.

Overrides:

doWriteTo in class PipelineAggregator

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from class: PipelineAggregator

The name of the writeable object.

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Overrides:

getWriteableName in class PipelineAggregator

reduce

public InternalAggregation reduce(InternalAggregation aggregation,
 InternalAggregation.ReduceContext reduceContext)

Specified by:

reduce in class PipelineAggregator