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

Class RangeAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

org.opensearch.client.opensearch._types.aggregations.RangeAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static RangeAggregation.Builder	builder()
boolean	equals(Object o)
final String	field()	API name: field
final String	format()	API name: format
int	hashCode()
final Boolean	keyed()	Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
final Integer	missing()	The value to apply to documents that do not have a value.
static RangeAggregation	of(Function<RangeAggregation.Builder,ObjectBuilder<RangeAggregation>> fn)
final List<AggregationRange>	ranges()	An array of ranges used to bucket documents.
final Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupRangeAggregationDeserializer(ObjectDeserializer<RangeAggregation.Builder> op)
RangeAggregation.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.BucketAggregationBase

setupBucketAggregationBaseDeserializer

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

meta, name, serialize, setupAggregationBaseDeserializer

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

Json deserializer for RangeAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

field

@Nullable
public final String field()

API name: field

format

@Nullable
public final String format()

API name: format

keyed

@Nullable
public final Boolean keyed()

Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.

API name: keyed

missing

@Nullable
public final Integer missing()

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

API name: missing

ranges

@Nonnull
public final List<AggregationRange> ranges()

An array of ranges used to bucket documents.

API name: ranges

script

@Nullable
public final Script script()

API name: script

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static RangeAggregation.Builder builder()

setupRangeAggregationDeserializer

protected static void setupRangeAggregationDeserializer(ObjectDeserializer<RangeAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase