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

Class WeightedAverageAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.aggregations.WeightedAverageAggregation.Builder

All Implemented Interfaces:

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

Enclosing class:

WeightedAverageAggregation

public static class WeightedAverageAggregation.Builder
extends AggregationBase.AbstractBuilder<WeightedAverageAggregation.Builder>
implements CopyableBuilder<WeightedAverageAggregation.Builder,WeightedAverageAggregation>

Builder for WeightedAverageAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
WeightedAverageAggregation	build()	Builds a WeightedAverageAggregation.
WeightedAverageAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final WeightedAverageAggregation.Builder	format(String value)	A numeric response formatter.
protected WeightedAverageAggregation.Builder	self()
final WeightedAverageAggregation.Builder	value(Function<WeightedAverageValue.Builder,ObjectBuilder<WeightedAverageValue>> fn)	API name: value
final WeightedAverageAggregation.Builder	value(WeightedAverageValue value)	API name: value
final WeightedAverageAggregation.Builder	valueType(ValueType value)	API name: value_type
final WeightedAverageAggregation.Builder	weight(Function<WeightedAverageValue.Builder,ObjectBuilder<WeightedAverageValue>> fn)	API name: weight
final WeightedAverageAggregation.Builder	weight(WeightedAverageValue value)	API name: weight

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

Returns:

a new builder instance.

self

@Nonnull
protected WeightedAverageAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<WeightedAverageAggregation.Builder>

format

@Nonnull
public final WeightedAverageAggregation.Builder format(@Nullable
 String value)

A numeric response formatter.

API name: format

value

@Nonnull
public final WeightedAverageAggregation.Builder value(@Nullable
 WeightedAverageValue value)

API name: value

value

@Nonnull
public final WeightedAverageAggregation.Builder value(Function<WeightedAverageValue.Builder,ObjectBuilder<WeightedAverageValue>> fn)

API name: value

valueType

@Nonnull
public final WeightedAverageAggregation.Builder valueType(@Nullable
 ValueType value)

API name: value_type

weight

@Nonnull
public final WeightedAverageAggregation.Builder weight(@Nullable
 WeightedAverageValue value)

API name: weight

weight

@Nonnull
public final WeightedAverageAggregation.Builder weight(Function<WeightedAverageValue.Builder,ObjectBuilder<WeightedAverageValue>> fn)

API name: weight

build

@Nonnull
public WeightedAverageAggregation build()

Builds a WeightedAverageAggregation.

Specified by:

build in interface ObjectBuilder<WeightedAverageAggregation>

Throws:

NullPointerException - if some of the required fields are null.