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

Class TopMetricsAggregation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopMetricsAggregation	build()	Builds a TopMetricsAggregation.
TopMetricsAggregation.Builder	metrics(java.util.function.Function<TopMetricsValue.Builder,ObjectBuilder<TopMetricsValue>> fn)	API name: metrics
TopMetricsAggregation.Builder	metrics(java.util.List<TopMetricsValue> list)	API name: metrics
TopMetricsAggregation.Builder	metrics(TopMetricsValue value, TopMetricsValue... values)	API name: metrics
protected TopMetricsAggregation.Builder	self()
TopMetricsAggregation.Builder	size(java.lang.Integer value)	API name: size
TopMetricsAggregation.Builder	sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
TopMetricsAggregation.Builder	sort(java.util.List<SortOptions> list)	API name: sort
TopMetricsAggregation.Builder	sort(SortOptions value, SortOptions... values)	API name: sort

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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

metrics

public final TopMetricsAggregation.Builder metrics(java.util.List<TopMetricsValue> list)

API name: metrics

Adds all elements of list to metrics.

metrics

public final TopMetricsAggregation.Builder metrics(TopMetricsValue value,
                                                   TopMetricsValue... values)

API name: metrics

Adds one or more values to metrics.

metrics

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

API name: metrics

Adds a value to metrics using a builder lambda.

size

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

API name: size

sort

public final TopMetricsAggregation.Builder sort(java.util.List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

public final TopMetricsAggregation.Builder sort(SortOptions value,
                                                SortOptions... values)

API name: sort

Adds one or more values to sort.

sort

public final TopMetricsAggregation.Builder sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

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.