Class TopMetricsAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder<TopMetricsAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.TopMetricsAggregation.Builder
- All Implemented Interfaces:
WithJson<TopMetricsAggregation.Builder>
,ObjectBuilder<TopMetricsAggregation>
- Enclosing class:
- TopMetricsAggregation
public static class TopMetricsAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<TopMetricsAggregation.Builder>
implements ObjectBuilder<TopMetricsAggregation>
Builder for
TopMetricsAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aTopMetricsAggregation
.metrics
(TopMetricsValue value, TopMetricsValue... values) The fields of the top document to return.The fields of the top document to return.metrics
(List<TopMetricsValue> list) The fields of the top document to return.protected TopMetricsAggregation.Builder
self()
The number of top documents from which to return metrics.sort
(SortOptions value, SortOptions... values) The sort order of the documents.The sort order of the documents.sort
(List<SortOptions> list) The sort order of the documents.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase.AbstractBuilder
field, missing, missing, missing, missing, missing, missing, script, script
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
metrics
The fields of the top document to return.API name:
metrics
Adds all elements of
list
tometrics
. -
metrics
public final TopMetricsAggregation.Builder metrics(TopMetricsValue value, TopMetricsValue... values) The fields of the top document to return.API name:
metrics
Adds one or more values to
metrics
. -
metrics
public final TopMetricsAggregation.Builder metrics(Function<TopMetricsValue.Builder, ObjectBuilder<TopMetricsValue>> fn) The fields of the top document to return.API name:
metrics
Adds a value to
metrics
using a builder lambda. -
size
The number of top documents from which to return metrics.API name:
size
-
sort
The sort order of the documents.API name:
sort
Adds all elements of
list
tosort
. -
sort
The sort order of the documents.API name:
sort
Adds one or more values to
sort
. -
sort
public final TopMetricsAggregation.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) The sort order of the documents.API name:
sort
Adds a value to
sort
using a builder lambda. -
self
- Specified by:
self
in classMetricAggregationBase.AbstractBuilder<TopMetricsAggregation.Builder>
-
build
Builds aTopMetricsAggregation
.- Specified by:
build
in interfaceObjectBuilder<TopMetricsAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-