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

Class PercentilesAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.PercentilesAggregation

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PercentilesAggregation
extends FormatMetricAggregationBase
implements AggregationVariant, ToCopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<PercentilesAggregation>	_DESERIALIZER	Json deserializer for PercentilesAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static PercentilesAggregation.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final HdrMethod	hdr()	API name: hdr
final Boolean	keyed()	By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.
static PercentilesAggregation	of(Function<PercentilesAggregation.Builder,ObjectBuilder<PercentilesAggregation>> fn)
final List<Double>	percents()	The percentiles to calculate.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPercentilesAggregationDeserializer(ObjectDeserializer<PercentilesAggregation.Builder> op)
final TDigest	tdigest()	API name: tdigest
PercentilesAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PercentilesAggregation> _DESERIALIZER

Json deserializer for PercentilesAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

hdr

@Nullable
public final HdrMethod hdr()

API name: hdr

keyed

@Nullable
public final Boolean keyed()

By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array. Set to false to disable this behavior.

API name: keyed

percents

@Nonnull
public final List<Double> percents()

The percentiles to calculate.

API name: percents

tdigest

@Nullable
public final TDigest tdigest()

API name: tdigest

serializeInternal

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

Overrides:

serializeInternal in class FormatMetricAggregationBase

toBuilder

@Nonnull
public PercentilesAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PercentilesAggregation.Builder,PercentilesAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static PercentilesAggregation.Builder builder()

setupPercentilesAggregationDeserializer

protected static void setupPercentilesAggregationDeserializer(ObjectDeserializer<PercentilesAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class FormatMetricAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class FormatMetricAggregationBase