Package org.opensearch.search.aggregations.pipeline

Class MovFnPipelineAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

org.opensearch.search.aggregations.pipeline.MovFnPipelineAggregationBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder

public class MovFnPipelineAggregationBuilder
extends AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

Aggregation Builder for moving_fn

Opensearch.internal:

Nested Class Summary

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

PipelineAggregationBuilder.ValidationContext

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

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>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final org.opensearch.core.xcontent.ConstructingObjectParser<MovFnPipelineAggregationBuilder,String>	PARSER

Fields inherited from class org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

BUCKETS_PATH_FIELD, metadata, type

Fields inherited from class org.opensearch.search.aggregations.PipelineAggregationBuilder

bucketsPaths, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MovFnPipelineAggregationBuilder(String name, String bucketsPath, Script script, int window)
MovFnPipelineAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected PipelineAggregator	createInternal(Map<String,Object> metadata)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
boolean	equals(Object obj)
String	format()	Gets the format to use on the output of this aggregation.
MovFnPipelineAggregationBuilder	format(String format)	Sets the format to use on the output of this aggregation.
protected DocValueFormat	formatter()
BucketHelpers.GapPolicy	gapPolicy()	Gets the gap policy to use for this aggregation.
MovFnPipelineAggregationBuilder	gapPolicy(BucketHelpers.GapPolicy gapPolicy)	Sets the gap policy to use for this aggregation.
int	getWindow()	Returns the window size for this aggregation
String	getWriteableName()
int	hashCode()
protected org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected boolean	overrideBucketsPath()
void	setShift(int shift)
void	setWindow(int window)	Sets the window size for this aggregation
protected void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

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

create, getType, setMetadata, toXContent, type, writeTo

Methods inherited from class org.opensearch.search.aggregations.PipelineAggregationBuilder

getBucketsPaths, getName, rewrite, subAggregations, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PARSER

public static final org.opensearch.core.xcontent.ConstructingObjectParser<MovFnPipelineAggregationBuilder,String> PARSER

Constructor Details

MovFnPipelineAggregationBuilder

public MovFnPipelineAggregationBuilder(String name,
 String bucketsPath,
 Script script,
 int window)

MovFnPipelineAggregationBuilder

public MovFnPipelineAggregationBuilder(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

Specified by:

doWriteTo in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

Throws:

IOException

format

public MovFnPipelineAggregationBuilder format(String format)

Sets the format to use on the output of this aggregation.

format

public String format()

Gets the format to use on the output of this aggregation.

formatter

protected DocValueFormat formatter()

gapPolicy

public MovFnPipelineAggregationBuilder gapPolicy(BucketHelpers.GapPolicy gapPolicy)

Sets the gap policy to use for this aggregation.

gapPolicy

public BucketHelpers.GapPolicy gapPolicy()

Gets the gap policy to use for this aggregation.

getWindow

public int getWindow()

Returns the window size for this aggregation

setWindow

public void setWindow(int window)

Sets the window size for this aggregation

setShift

public void setShift(int shift)

validate

protected void validate(PipelineAggregationBuilder.ValidationContext context)

Description copied from class: PipelineAggregationBuilder

Makes sure this builder is properly configured.

Specified by:

validate in class PipelineAggregationBuilder

createInternal

protected PipelineAggregator createInternal(Map<String,Object> metadata)

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

internalXContent

protected org.opensearch.core.xcontent.XContentBuilder internalXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                 throws IOException

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

Throws:

IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Overrides:

overrideBucketsPath in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

Returns:

true if the AbstractPipelineAggregationBuilder overrides the XContent rendering of the bucketPath option.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractPipelineAggregationBuilder<MovFnPipelineAggregationBuilder>

getWriteableName

public String getWriteableName()