org.elasticsearch.search.aggregations.pipeline.movavg.models

Class EwmaModel.EWMAModelBuilder

java.lang.Object

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

All Implemented Interfaces:

ToXContent, MovAvgModelBuilder

Enclosing class:

EwmaModel

public static class EwmaModel.EWMAModelBuilder
extends Object
implements MovAvgModelBuilder

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 interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
EwmaModel.EWMAModelBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
EwmaModel.EWMAModelBuilder	alpha(double alpha) Alpha controls the smoothing of the data.
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

Constructor Detail

EwmaModel.EWMAModelBuilder

public EwmaModel.EWMAModelBuilder()

Method Detail

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