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

Class MetricAggregationBase

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

BoxplotAggregation, CardinalityAggregation, FormatMetricAggregationBase, FormattableMetricAggregation, GeoBoundsAggregation, GeoCentroidAggregation, ScriptedMetricAggregation, StringStatsAggregation, TopHitsAggregation, TopMetricsAggregation

public abstract class MetricAggregationBase
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricAggregationBase.AbstractBuilder<BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetricAggregationBase(MetricAggregationBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final String	field()	The field on which to run the aggregation.
final FieldValue	missing()	The value to apply to documents that do not have a value.
final Script	script()	API name: script
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>> void	setupMetricAggregationBaseDeserializer(ObjectDeserializer<BuilderT> op)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MetricAggregationBase

protected MetricAggregationBase(MetricAggregationBase.AbstractBuilder<?> builder)

Method Details

field

@Nullable
public final String field()

The field on which to run the aggregation.

API name: field

missing

@Nullable
public final FieldValue missing()

The value to apply to documents that do not have a value. By default, documents without a value are ignored.

API name: missing

script

@Nullable
public final Script script()

API name: script

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toString

public String toString()

Overrides:

toString in class Object

setupMetricAggregationBaseDeserializer

protected static <BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>>
void setupMetricAggregationBaseDeserializer(ObjectDeserializer<BuilderT> op)