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

Class TopMetricsAggregation.Builder

java.lang.Object

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

org.opensearch.client.opensearch._types.aggregations.TopMetricsAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<TopMetricsAggregation>

Enclosing class:

TopMetricsAggregation

public static class TopMetricsAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<TopMetricsAggregation.Builder>
implements ObjectBuilder<TopMetricsAggregation>

Builder for TopMetricsAggregation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopMetricsAggregation.Builder	addMetrics(java.util.function.Function<TopMetricsValue.Builder,ObjectBuilder<TopMetricsValue>> fn)	Add a value to metrics(List), creating the list if needed.
TopMetricsAggregation.Builder	addMetrics(TopMetricsValue value)	Add a value to metrics(List), creating the list if needed.
TopMetricsAggregation.Builder	addSort(jakarta.json.JsonValue value)	Add a value to sort(List), creating the list if needed.
TopMetricsAggregation	build()	Builds a TopMetricsAggregation.
TopMetricsAggregation.Builder	metrics(java.util.function.Function<TopMetricsValue.Builder,ObjectBuilder<TopMetricsValue>> fn)	Set metrics(List) to a singleton list.
TopMetricsAggregation.Builder	metrics(java.util.List<TopMetricsValue> value)	API name: metrics
TopMetricsAggregation.Builder	metrics(TopMetricsValue... value)	API name: metrics
protected TopMetricsAggregation.Builder	self()
TopMetricsAggregation.Builder	size(java.lang.Number value)	API name: size
TopMetricsAggregation.Builder	sort(jakarta.json.JsonValue... value)	API name: sort
TopMetricsAggregation.Builder	sort(java.util.List<jakarta.json.JsonValue> value)	API name: sort

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

field, missing, script

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

metrics

public TopMetricsAggregation.Builder metrics(@Nullable java.util.List<TopMetricsValue> value)

API name: metrics

metrics

public TopMetricsAggregation.Builder metrics(TopMetricsValue... value)

API name: metrics

addMetrics

public TopMetricsAggregation.Builder addMetrics(TopMetricsValue value)

Add a value to metrics(List), creating the list if needed.

metrics

public TopMetricsAggregation.Builder metrics(java.util.function.Function<TopMetricsValue.Builder,ObjectBuilder<TopMetricsValue>> fn)

Set metrics(List) to a singleton list.

addMetrics

public TopMetricsAggregation.Builder addMetrics(java.util.function.Function<TopMetricsValue.Builder,ObjectBuilder<TopMetricsValue>> fn)

Add a value to metrics(List), creating the list if needed.

size

public TopMetricsAggregation.Builder size(@Nullable java.lang.Number value)

API name: size

sort

public TopMetricsAggregation.Builder sort(@Nullable java.util.List<jakarta.json.JsonValue> value)

API name: sort

sort

public TopMetricsAggregation.Builder sort(jakarta.json.JsonValue... value)

API name: sort

addSort

public TopMetricsAggregation.Builder addSort(jakarta.json.JsonValue value)

Add a value to sort(List), creating the list if needed.

self

protected TopMetricsAggregation.Builder self()

Specified by:

self in class MetricAggregationBase.AbstractBuilder<TopMetricsAggregation.Builder>

build

public TopMetricsAggregation build()

Builds a TopMetricsAggregation.

Specified by:

build in interface ObjectBuilder<TopMetricsAggregation>

Throws:

java.lang.NullPointerException - if some of the required fields are null.