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

Class TopMetrics.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.aggregations.TopMetrics.Builder

All Implemented Interfaces:

ObjectBuilder<TopMetrics>

Enclosing class:

TopMetrics

public static class TopMetrics.Builder
extends ObjectBuilderBase
implements ObjectBuilder<TopMetrics>

Builder for TopMetrics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TopMetrics	build()	Builds a TopMetrics.
TopMetrics.Builder	metrics(java.lang.String key, java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: metrics
TopMetrics.Builder	metrics(java.lang.String key, FieldValue value)	Required - API name: metrics
TopMetrics.Builder	metrics(java.util.Map<java.lang.String,FieldValue> map)	Required - API name: metrics
TopMetrics.Builder	sort(java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	Required - API name: sort
TopMetrics.Builder	sort(java.util.List<FieldValue> list)	Required - API name: sort
TopMetrics.Builder	sort(FieldValue value, FieldValue... values)	Required - API name: sort

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

sort

public final TopMetrics.Builder sort(java.util.List<FieldValue> list)

Required - API name: sort

Adds all elements of list to sort.

sort

public final TopMetrics.Builder sort(FieldValue value,
                                     FieldValue... values)

Required - API name: sort

Adds one or more values to sort.

sort

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

Required - API name: sort

Adds a value to sort using a builder lambda.

metrics

public final TopMetrics.Builder metrics(java.util.Map<java.lang.String,FieldValue> map)

Required - API name: metrics

Adds all entries of map to metrics.

metrics

public final TopMetrics.Builder metrics(java.lang.String key,
                                        FieldValue value)

Required - API name: metrics

Adds an entry to metrics.

metrics

public final TopMetrics.Builder metrics(java.lang.String key,
                                        java.util.function.Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

Required - API name: metrics

Adds an entry to metrics using a builder lambda.

build

public TopMetrics build()

Builds a TopMetrics.

Specified by:

build in interface ObjectBuilder<TopMetrics>

Throws:

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