Package org.elasticsearch.search.aggregations.pipeline

Class EwmaModel.EWMAModelBuilder

java.lang.Object

org.elasticsearch.search.aggregations.pipeline.EwmaModel.EWMAModelBuilder

All Implemented Interfaces:

MovAvgModelBuilder, ToXContent, ToXContentFragment

Enclosing class:

EwmaModel

public static class EwmaModel.EWMAModelBuilder
extends Object
implements MovAvgModelBuilder

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EWMAModelBuilder()

Method Summary

Modifier and Type	Method	Description
EwmaModel.EWMAModelBuilder	alpha(double alpha)	Alpha controls the smoothing of the data.
MovAvgModel	build()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

EWMAModelBuilder

public EWMAModelBuilder()

Method Details

alpha

public EwmaModel.EWMAModelBuilder alpha(double alpha)

Alpha controls the smoothing of the data. Alpha = 1 retains no memory of past values (e.g. a random walk), while alpha = 0 retains infinite memory of past values (e.g. the series mean). Useful values are somewhere in between. Defaults to 0.5.

Parameters:

alpha - A double between 0-1 inclusive, controls data smoothing

Returns:

The builder to continue chaining

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

build

public MovAvgModel build()

Specified by:

build in interface MovAvgModelBuilder