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

Class DateRangeAggregation

java.lang.Object

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

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

co.elastic.clients.elasticsearch._types.aggregations.DateRangeAggregation

All Implemented Interfaces:

AggregationVariant, ApiKeyAggregationVariant, JsonpSerializable

@JsonpDeserializable
public class DateRangeAggregation
extends BucketAggregationBase
implements AggregationVariant, ApiKeyAggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

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()	The date format used to format from and to in the response.
final Boolean	keyed()	Set to true to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.
final FieldValue	missing()	The value to apply to documents that do not have a value.
static DateRangeAggregation	of(Function<DateRangeAggregation.Builder,ObjectBuilder<DateRangeAggregation>> fn)
final List<DateRangeExpression>	ranges()	Array of date ranges.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op)
final String	timeZone()	Time zone used to convert dates from another time zone to UTC.

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

Json deserializer for DateRangeAggregation

Method Details

of

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

format

@Nullable
public final String format()

The date format used to format from and to in the response.

API name: format

missing

@Nullable
public final FieldValue 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<DateRangeExpression> ranges()

Array of date ranges.

API name: ranges

timeZone

@Nullable
public final String timeZone()

Time zone used to convert dates from another time zone to UTC.

API name: time_zone

keyed

@Nullable
public final Boolean keyed()

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

API name: keyed

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupDateRangeAggregationDeserializer

protected static void setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op)