org.elasticsearch.search.aggregations.pipeline.movavg

Class MovAvgBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder<MovAvgBuilder>

org.elasticsearch.search.aggregations.pipeline.movavg.MovAvgBuilder

All Implemented Interfaces:

ToXContent

public class MovAvgBuilder
extends PipelineAggregatorBuilder<MovAvgBuilder>

A builder to create MovingAvg pipeline aggregations

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 class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
MovAvgBuilder(String name)

Method Summary

Methods

Modifier and Type	Method and Description
MovAvgBuilder	format(String format)
MovAvgBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy) Defines what should be done when a gap in the series is discovered
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
MovAvgBuilder	minimize(boolean minimize) Determines if the model should be fit to the data using a cost minimizing algorithm.
MovAvgBuilder	modelBuilder(MovAvgModelBuilder modelBuilder) Sets a MovAvgModelBuilder for the Moving Average.
MovAvgBuilder	predict(int numPredictions) Sets the number of predictions that should be returned.
MovAvgBuilder	settings(Map<String,Object> settings) The hash of settings that should be provided to the model when it is instantiated
MovAvgBuilder	window(int window) Sets the window size for the moving average.

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder

setBucketsPaths, setMetaData, toXContent

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

MovAvgBuilder

public MovAvgBuilder(String name)

Method Detail

format

public MovAvgBuilder format(String format)

gapPolicy

public MovAvgBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

Defines what should be done when a gap in the series is discovered

Parameters:

gapPolicy - A GapPolicy enum defining the selected policy

Returns:

Returns the builder to continue chaining

modelBuilder

public MovAvgBuilder modelBuilder(MovAvgModelBuilder modelBuilder)

Sets a MovAvgModelBuilder for the Moving Average. The model builder is used to define what type of moving average you want to use on the series

Parameters:

modelBuilder - A MovAvgModelBuilder which has been prepopulated with settings

Returns:

Returns the builder to continue chaining

window

public MovAvgBuilder window(int window)

Sets the window size for the moving average. This window will "slide" across the series, and the values inside that window will be used to calculate the moving avg value

Parameters:

window - Size of window

Returns:

Returns the builder to continue chaining

predict

public MovAvgBuilder predict(int numPredictions)

Sets the number of predictions that should be returned. Each prediction will be spaced at the intervals specified in the histogram. E.g "predict: 2" will return two new buckets at the end of the histogram with the predicted values.

Parameters:

numPredictions - Number of predictions to make

Returns:

Returns the builder to continue chaining

minimize

public MovAvgBuilder minimize(boolean minimize)

Determines if the model should be fit to the data using a cost minimizing algorithm.

Parameters:

minimize - If the model should be fit to the underlying data

Returns:

Returns the builder to continue chaining

settings

public MovAvgBuilder settings(Map<String,Object> settings)

The hash of settings that should be provided to the model when it is instantiated

internalXContent

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

Specified by:

internalXContent in class PipelineAggregatorBuilder<MovAvgBuilder>

Throws:

IOException