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

Class ExtendedStatsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<ExtendedStatsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase.AbstractBuilder<ExtendedStatsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.ExtendedStatsAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

ExtendedStatsAggregation

public static class ExtendedStatsAggregation.Builder
extends FormatMetricAggregationBase.AbstractBuilder<ExtendedStatsAggregation.Builder>
implements CopyableBuilder<ExtendedStatsAggregation.Builder,ExtendedStatsAggregation>

Builder for ExtendedStatsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExtendedStatsAggregation	build()	Builds a ExtendedStatsAggregation.
ExtendedStatsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
protected ExtendedStatsAggregation.Builder	self()
final ExtendedStatsAggregation.Builder	sigma(Double value)	The number of standard deviations above/below the mean to display.

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

format

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

field, missing, missing, script, script

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

Returns:

a new builder instance.

self

@Nonnull
protected ExtendedStatsAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<ExtendedStatsAggregation.Builder>

sigma

@Nonnull
public final ExtendedStatsAggregation.Builder sigma(@Nullable
 Double value)

The number of standard deviations above/below the mean to display.

API name: sigma

build

@Nonnull
public ExtendedStatsAggregation build()

Builds a ExtendedStatsAggregation.

Specified by:

build in interface ObjectBuilder<ExtendedStatsAggregation>

Throws:

NullPointerException - if some of the required fields are null.