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

Class RangeAggregation

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

co.elastic.clients.elasticsearch._types.aggregations.RangeAggregation

All Implemented Interfaces:

AggregationVariant, ApiKeyAggregationVariant, JsonpSerializable

@JsonpDeserializable
public class RangeAggregation
extends BucketAggregationBase
implements AggregationVariant, ApiKeyAggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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.
ApiKeyAggregation.Kind	_apiKeyAggregationKind()	ApiKeyAggregation variant kind.
final String	field()	The date field whose values are use to build ranges.
final String	format()	API name: format
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)

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase

setupBucketAggregationBaseDeserializer

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant

_toAggregation

Methods inherited from interface co.elastic.clients.elasticsearch.security.query_api_keys.ApiKeyAggregationVariant

_toApiKeyAggregation

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

_apiKeyAggregationKind

public ApiKeyAggregation.Kind _apiKeyAggregationKind()

ApiKeyAggregation variant kind.

Specified by:

_apiKeyAggregationKind in interface ApiKeyAggregationVariant

field

@Nullable
public final String field()

The date field whose values are use to build ranges.

API name: field

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

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

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

format

@Nullable
public final String format()

API name: format

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupRangeAggregationDeserializer

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