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

Class BucketMetricValueAggregate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.AggregateBase.AbstractBuilder<BucketMetricValueAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.SingleMetricAggregateBase.AbstractBuilder<BucketMetricValueAggregate.Builder>

org.opensearch.client.opensearch._types.aggregations.BucketMetricValueAggregate.Builder

All Implemented Interfaces:

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

Enclosing class:

BucketMetricValueAggregate

public static class BucketMetricValueAggregate.Builder
extends SingleMetricAggregateBase.AbstractBuilder<BucketMetricValueAggregate.Builder>
implements CopyableBuilder<BucketMetricValueAggregate.Builder,BucketMetricValueAggregate>

Builder for BucketMetricValueAggregate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketMetricValueAggregate	build()	Builds a BucketMetricValueAggregate.
BucketMetricValueAggregate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final BucketMetricValueAggregate.Builder	keys(String value, String... values)	Required - API name: keys
final BucketMetricValueAggregate.Builder	keys(List<String> list)	Required - API name: keys
protected BucketMetricValueAggregate.Builder	self()

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

value, valueAsString

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

meta, meta

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

Returns:

a new builder instance.

self

@Nonnull
protected BucketMetricValueAggregate.Builder self()

Specified by:

self in class AggregateBase.AbstractBuilder<BucketMetricValueAggregate.Builder>

keys

@Nonnull
public final BucketMetricValueAggregate.Builder keys(List<String> list)

Required - API name: keys

Adds all elements of list to keys.

keys

@Nonnull
public final BucketMetricValueAggregate.Builder keys(String value,
 String... values)

Required - API name: keys

Adds one or more values to keys.

build

@Nonnull
public BucketMetricValueAggregate build()

Builds a BucketMetricValueAggregate.

Specified by:

build in interface ObjectBuilder<BucketMetricValueAggregate>

Throws:

NullPointerException - if some of the required fields are null.