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

Class AutoDateHistogramAggregation

java.lang.Object

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

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

co.elastic.clients.elasticsearch._types.aggregations.AutoDateHistogramAggregation

All Implemented Interfaces:

AggregationVariant, JsonpSerializable

@JsonpDeserializable
public class AutoDateHistogramAggregation
extends BucketAggregationBase
implements AggregationVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
final Integer	buckets()	The target number of buckets.
final String	field()	The field on which to run the aggregation.
final String	format()	The date format used to format key_as_string in the response.
final MinimumInterval	minimumInterval()	The minimum rounding interval.
final DateTime	missing()	The value to apply to documents that do not have a value.
static AutoDateHistogramAggregation	of(Function<AutoDateHistogramAggregation.Builder,ObjectBuilder<AutoDateHistogramAggregation>> fn)
final String	offset()	Time zone specified as a ISO 8601 UTC offset.
final Map<String,JsonData>	params()	API name: params
final Script	script()	API name: script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAutoDateHistogramAggregationDeserializer(ObjectDeserializer<AutoDateHistogramAggregation.Builder> op)
final String	timeZone()	Time zone ID.

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<AutoDateHistogramAggregation> _DESERIALIZER

Json deserializer for AutoDateHistogramAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

buckets

@Nullable
public final Integer buckets()

The target number of buckets.

API name: buckets

field

@Nullable
public final String field()

The field on which to run the aggregation.

API name: field

format

@Nullable
public final String format()

The date format used to format key_as_string in the response. If no format is specified, the first date format specified in the field mapping is used.

API name: format

minimumInterval

@Nullable
public final MinimumInterval minimumInterval()

The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than minimum_interval.

API name: minimum_interval

missing

@Nullable
public final DateTime missing()

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

API name: missing

offset

@Nullable
public final String offset()

Time zone specified as a ISO 8601 UTC offset.

API name: offset

params

public final Map<String,JsonData> params()

API name: params

script

@Nullable
public final Script script()

API name: script

timeZone

@Nullable
public final String timeZone()

Time zone ID.

API name: time_zone

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupAutoDateHistogramAggregationDeserializer

protected static void setupAutoDateHistogramAggregationDeserializer(ObjectDeserializer<AutoDateHistogramAggregation.Builder> op)