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

Class PercentileRanksAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.PercentileRanksAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<PercentileRanksAggregation>	_DESERIALIZER	Json deserializer for PercentileRanksAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static PercentileRanksAggregation.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 PercentileRanksAggregation	of(Function<PercentileRanksAggregation.Builder,ObjectBuilder<PercentileRanksAggregation>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPercentileRanksAggregationDeserializer(ObjectDeserializer<PercentileRanksAggregation.Builder> op)
final TDigest	tdigest()	API name: tdigest
PercentileRanksAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final List<Double>	values()	An array of values for which to calculate the percentile ranks.

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<PercentileRanksAggregation> _DESERIALIZER

Json deserializer for PercentileRanksAggregation

Method Details

of

public static PercentileRanksAggregation of(Function<PercentileRanksAggregation.Builder,ObjectBuilder<PercentileRanksAggregation>> 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

tdigest

@Nullable
public final TDigest tdigest()

API name: tdigest

values

@Nonnull
public final List<Double> values()

An array of values for which to calculate the percentile ranks.

API name: values

serializeInternal

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

Overrides:

serializeInternal in class FormatMetricAggregationBase

toBuilder

@Nonnull
public PercentileRanksAggregation.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<PercentileRanksAggregation.Builder,PercentileRanksAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static PercentileRanksAggregation.Builder builder()

setupPercentileRanksAggregationDeserializer

protected static void setupPercentileRanksAggregationDeserializer(ObjectDeserializer<PercentileRanksAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class FormatMetricAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class FormatMetricAggregationBase