Package co.elastic.clients.elasticsearch._types.aggregations

Class TopMetricsAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.TopMetricsAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class TopMetricsAggregation
extends MetricAggregationBase
implements AggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopMetricsAggregation.Builder	Builder for TopMetricsAggregation.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

MetricAggregationBase.AbstractBuilder<BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TopMetricsAggregation>	_DESERIALIZER	Json deserializer for TopMetricsAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final List<TopMetricsValue>	metrics()	The fields of the top document to return.
static TopMetricsAggregation	of(Function<TopMetricsAggregation.Builder,ObjectBuilder<TopMetricsAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTopMetricsAggregationDeserializer(ObjectDeserializer<TopMetricsAggregation.Builder> op)
final Integer	size()	The number of top documents from which to return metrics.
final List<SortOptions>	sort()	The sort order of the documents.

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.MetricAggregationBase

field, missing, script, serialize, setupMetricAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TopMetricsAggregation> _DESERIALIZER

Json deserializer for TopMetricsAggregation

Method Details

of

public static TopMetricsAggregation of(Function<TopMetricsAggregation.Builder,ObjectBuilder<TopMetricsAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

metrics

public final List<TopMetricsValue> metrics()

The fields of the top document to return.

API name: metrics

size

@Nullable
public final Integer size()

The number of top documents from which to return metrics.

API name: size

sort

public final List<SortOptions> sort()

The sort order of the documents.

API name: sort

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class MetricAggregationBase

setupTopMetricsAggregationDeserializer

protected static void setupTopMetricsAggregationDeserializer(ObjectDeserializer<TopMetricsAggregation.Builder> op)