Package org.opensearch.client.opensearch._types.aggregations

Class MovingFunctionAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<MovingFunctionAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketPathAggregation.AbstractBuilder<MovingFunctionAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase.AbstractBuilder<MovingFunctionAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.MovingFunctionAggregation.Builder

All Implemented Interfaces:

CopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>, MutableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>, ObjectBuilder<MovingFunctionAggregation>

Enclosing class:

MovingFunctionAggregation

public static class MovingFunctionAggregation.Builder
extends PipelineAggregationBase.AbstractBuilder<MovingFunctionAggregation.Builder>
implements CopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>

Builder for MovingFunctionAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MovingFunctionAggregation	build()	Builds a MovingFunctionAggregation.
MovingFunctionAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MovingFunctionAggregation.Builder	script(String value)	The script that should be executed on each window of data.
protected MovingFunctionAggregation.Builder	self()
final MovingFunctionAggregation.Builder	shift(Integer value)	By default, the window consists of the last n values excluding the current bucket.
final MovingFunctionAggregation.Builder	window(Integer value)	The size of window to "slide" across the histogram.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase.AbstractBuilder

format, gapPolicy

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketPathAggregation.AbstractBuilder

bucketsPath, bucketsPath

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder

meta, meta, name

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public MovingFunctionAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected MovingFunctionAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<MovingFunctionAggregation.Builder>

script

@Nonnull
public final MovingFunctionAggregation.Builder script(@Nullable
 String value)

The script that should be executed on each window of data.

API name: script

shift

@Nonnull
public final MovingFunctionAggregation.Builder shift(@Nullable
 Integer value)

By default, the window consists of the last n values excluding the current bucket. Increasing shift by 1, moves the starting window position by 1 to the right.

API name: shift

window

@Nonnull
public final MovingFunctionAggregation.Builder window(@Nullable
 Integer value)

The size of window to "slide" across the histogram.

API name: window

build

@Nonnull
public MovingFunctionAggregation build()

Builds a MovingFunctionAggregation.

Specified by:

build in interface ObjectBuilder<MovingFunctionAggregation>

Throws:

NullPointerException - if some of the required fields are null.