Package org.opensearch.search.aggregations.pipeline

Class HoltWintersModel.HoltWintersModelBuilder

java.lang.Object

org.opensearch.search.aggregations.pipeline.HoltWintersModel.HoltWintersModelBuilder

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, MovAvgModelBuilder

Enclosing class:

HoltWintersModel

public static class HoltWintersModel.HoltWintersModelBuilder
extends Object
implements MovAvgModelBuilder

Builder for the holt winters model

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
HoltWintersModelBuilder()

Method Summary

Modifier and Type	Method	Description
HoltWintersModel.HoltWintersModelBuilder	alpha(double alpha)	Alpha controls the smoothing of the data.
HoltWintersModel.HoltWintersModelBuilder	beta(double beta)	Equivalent to alpha, but controls the smoothing of the trend instead of the data
MovAvgModel	build()
HoltWintersModel.HoltWintersModelBuilder	gamma(double gamma)
HoltWintersModel.HoltWintersModelBuilder	pad(boolean pad)
HoltWintersModel.HoltWintersModelBuilder	period(int period)
HoltWintersModel.HoltWintersModelBuilder	seasonalityType(HoltWintersModel.SeasonalityType type)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.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.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

HoltWintersModelBuilder

public HoltWintersModelBuilder()

Method Details

alpha

public HoltWintersModel.HoltWintersModelBuilder 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

beta

public HoltWintersModel.HoltWintersModelBuilder beta(double beta)

Equivalent to alpha, but controls the smoothing of the trend instead of the data

Parameters:

beta - a double between 0-1 inclusive, controls trend smoothing

Returns:

The builder to continue chaining

gamma

public HoltWintersModel.HoltWintersModelBuilder gamma(double gamma)

period

public HoltWintersModel.HoltWintersModelBuilder period(int period)

seasonalityType

public HoltWintersModel.HoltWintersModelBuilder seasonalityType(HoltWintersModel.SeasonalityType type)

pad

public HoltWintersModel.HoltWintersModelBuilder pad(boolean pad)

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

build

public MovAvgModel build()

Specified by:

build in interface MovAvgModelBuilder