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

Class DateHistogramAggregation

java.lang.Object

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

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

co.elastic.clients.elasticsearch._types.aggregations.DateHistogramAggregation

All Implemented Interfaces:

AggregationVariant, PivotGroupByVariant, JsonpSerializable

@JsonpDeserializable
public class DateHistogramAggregation
extends BucketAggregationBase
implements AggregationVariant, PivotGroupByVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
PivotGroupBy.Kind	_pivotGroupByKind()	PivotGroupBy variant kind.
final CalendarInterval	calendarInterval()	API name: calendar_interval
final ExtendedBounds<FieldDateMath>	extendedBounds()	API name: extended_bounds
final String	field()	API name: field
final Time	fixedInterval()	API name: fixed_interval
final String	format()	API name: format
final ExtendedBounds<FieldDateMath>	hardBounds()	API name: hard_bounds
final Time	interval()	Deprecated. 7.2.0 use fixed_interval or calendar_interval
final Boolean	keyed()	API name: keyed
final Integer	minDocCount()	API name: min_doc_count
final DateTime	missing()	API name: missing
static DateHistogramAggregation	of(Function<DateHistogramAggregation.Builder,ObjectBuilder<DateHistogramAggregation>> fn)
final Time	offset()	API name: offset
final List<NamedValue<SortOrder>>	order()	API name: order
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	setupDateHistogramAggregationDeserializer(ObjectDeserializer<DateHistogramAggregation.Builder> op)
final String	timeZone()	API name: time_zone

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.transform.PivotGroupByVariant

_toPivotGroupBy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DateHistogramAggregation> _DESERIALIZER

Json deserializer for DateHistogramAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

_pivotGroupByKind

public PivotGroupBy.Kind _pivotGroupByKind()

PivotGroupBy variant kind.

Specified by:

_pivotGroupByKind in interface PivotGroupByVariant

calendarInterval

@Nullable
public final CalendarInterval calendarInterval()

API name: calendar_interval

extendedBounds

@Nullable
public final ExtendedBounds<FieldDateMath> extendedBounds()

API name: extended_bounds

hardBounds

@Nullable
public final ExtendedBounds<FieldDateMath> hardBounds()

API name: hard_bounds

field

@Nullable
public final String field()

API name: field

fixedInterval

@Nullable
public final Time fixedInterval()

API name: fixed_interval

format

@Nullable
public final String format()

API name: format

interval

@Deprecated
@Nullable
public final Time interval()

Deprecated.

7.2.0 use fixed_interval or calendar_interval

API name: interval

minDocCount

@Nullable
public final Integer minDocCount()

API name: min_doc_count

missing

@Nullable
public final DateTime missing()

API name: missing

offset

@Nullable
public final Time offset()

API name: offset

order

public final List<NamedValue<SortOrder>> order()

API name: order

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()

API name: time_zone

keyed

@Nullable
public final Boolean keyed()

API name: keyed

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

setupDateHistogramAggregationDeserializer

protected static void setupDateHistogramAggregationDeserializer(ObjectDeserializer<DateHistogramAggregation.Builder> op)