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

Class MovingFunctionAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketPathAggregation

org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class MovingFunctionAggregation
extends PipelineAggregationBase
implements AggregationVariant, ToCopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MovingFunctionAggregation.Builder	Builder for MovingFunctionAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

PipelineAggregationBase.AbstractBuilder<BuilderT extends PipelineAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<MovingFunctionAggregation>	_DESERIALIZER	Json deserializer for MovingFunctionAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static MovingFunctionAggregation.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static MovingFunctionAggregation	of(Function<MovingFunctionAggregation.Builder,ObjectBuilder<MovingFunctionAggregation>> fn)
final String	script()	The script that should be executed on each window of data.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMovingFunctionAggregationDeserializer(ObjectDeserializer<MovingFunctionAggregation.Builder> op)
final Integer	shift()	By default, the window consists of the last n values excluding the current bucket.
MovingFunctionAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Integer	window()	The size of window to "slide" across the histogram.

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

format, gapPolicy, setupPipelineAggregationBaseDeserializer

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

bucketsPath, setupBucketPathAggregationDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<MovingFunctionAggregation> _DESERIALIZER

Json deserializer for MovingFunctionAggregation

Method Details

of

public static MovingFunctionAggregation of(Function<MovingFunctionAggregation.Builder,ObjectBuilder<MovingFunctionAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

script

@Nullable
public final String script()

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

API name: script

shift

@Nullable
public final Integer shift()

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

@Nullable
public final Integer window()

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

API name: window

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class PipelineAggregationBase

toBuilder

@Nonnull
public MovingFunctionAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MovingFunctionAggregation.Builder,MovingFunctionAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static MovingFunctionAggregation.Builder builder()

setupMovingFunctionAggregationDeserializer

protected static void setupMovingFunctionAggregationDeserializer(ObjectDeserializer<MovingFunctionAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class PipelineAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class PipelineAggregationBase