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

Class SerialDifferencingAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

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

org.opensearch.client.opensearch._types.aggregations.SerialDifferencingAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

SerialDifferencingAggregation

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

Builder for SerialDifferencingAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SerialDifferencingAggregation	build()	Builds a SerialDifferencingAggregation.
SerialDifferencingAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SerialDifferencingAggregation.Builder	lag(Integer value)	The historical bucket to subtract from the current value.
protected SerialDifferencingAggregation.Builder	self()

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 SerialDifferencingAggregation.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<SerialDifferencingAggregation.Builder,SerialDifferencingAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected SerialDifferencingAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SerialDifferencingAggregation.Builder>

lag

@Nonnull
public final SerialDifferencingAggregation.Builder lag(@Nullable
 Integer value)

The historical bucket to subtract from the current value. Must be a positive, non-zero integer.

API name: lag

build

@Nonnull
public SerialDifferencingAggregation build()

Builds a SerialDifferencingAggregation.

Specified by:

build in interface ObjectBuilder<SerialDifferencingAggregation>

Throws:

NullPointerException - if some of the required fields are null.