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

Class RateAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase

org.opensearch.client.opensearch._types.aggregations.RateAggregation

All Implemented Interfaces:

JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class RateAggregation
extends FormatMetricAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase

FormatMetricAggregationBase.AbstractBuilder<BuilderT extends FormatMetricAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
RateMode	mode()	API name: mode
static RateAggregation	of(java.util.function.Function<RateAggregation.Builder,ObjectBuilder<RateAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRateAggregationDeserializer(ObjectDeserializer<RateAggregation.Builder> op)
CalendarInterval	unit()	API name: unit

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.FormatMetricAggregationBase

format, setupFormatMetricAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

field, missing, script, serialize, setupMetricAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<RateAggregation> _DESERIALIZER

Json deserializer for RateAggregation

Method Detail

of

public static RateAggregation of(java.util.function.Function<RateAggregation.Builder,ObjectBuilder<RateAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

unit

@Nullable
public final CalendarInterval unit()

API name: unit

mode

@Nullable
public final RateMode mode()

API name: mode

serializeInternal

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

Overrides:

serializeInternal in class FormatMetricAggregationBase

setupRateAggregationDeserializer

protected static void setupRateAggregationDeserializer(ObjectDeserializer<RateAggregation.Builder> op)