java.lang.Object
- org.opensearch.client.opensearch._types.aggregations.AggregationBase
- - org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
  - - org.opensearch.client.opensearch._types.aggregations.DateHistogramAggregation

All Implemented Interfaces:: JsonpSerializable, AggregationVariant

@JsonpDeserializable
public class DateHistogramAggregation
extends BucketAggregationBase
implements AggregationVariant

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DateHistogramAggregation.Builder
Builder for DateHistogramAggregation.
- 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 JsonpDeserializer<DateHistogramAggregation> _DESERIALIZER
Json deserializer for DateHistogramAggregation

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Aggregation.Kind`	`_aggregationKind()`	Aggregation variant kind.
`CalendarInterval`	`calendarInterval()`	API name: `calendar_interval`
`ExtendedBounds<FieldDateMath>`	`extendedBounds()`	API name: `extended_bounds`
`java.lang.String`	`field()`	API name: `field`
`Time`	`fixedInterval()`	API name: `fixed_interval`
`java.lang.String`	`format()`	API name: `format`
`ExtendedBounds<FieldDateMath>`	`hardBounds()`	API name: `hard_bounds`
`Time`	`interval()`	API name: `interval`
`java.lang.Boolean`	`keyed()`	API name: `keyed`
`java.lang.Integer`	`minDocCount()`	API name: `min_doc_count`
`java.lang.String`	`missing()`	API name: `missing`
`static DateHistogramAggregation`	`of(java.util.function.Function<DateHistogramAggregation.Builder,ObjectBuilder<DateHistogramAggregation>> fn)`
`Time`	`offset()`	API name: `offset`
`HistogramOrder`	`order()`	API name: `order`
`java.util.Map<java.lang.String,JsonData>`	`params()`	API name: `params`
`Script`	`script()`	API name: `script`
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupDateHistogramAggregationDeserializer(ObjectDeserializer<DateHistogramAggregation.Builder> op)`
`java.lang.String`	`timeZone()`	API name: `time_zone`

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant
_toAggregation

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<DateHistogramAggregation> _DESERIALIZER

Json deserializer for DateHistogramAggregation

Method Detail

of

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

_aggregationKind
```
public Aggregation.Kind _aggregationKind()
```
Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

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 java.lang.String field()

API name: field

fixedInterval

@Nullable
public final Time fixedInterval()

API name: fixed_interval

format

@Nullable
public final java.lang.String format()

API name: format

interval

@Nullable
public final Time interval()

API name: interval

minDocCount

@Nullable
public final java.lang.Integer minDocCount()

API name: min_doc_count

missing

@Nullable
public final java.lang.String missing()

API name: missing

offset
```
@Nullable
public final Time offset()
```
API name: offset

order

@Nullable
public final HistogramOrder order()

API name: order

params

public final java.util.Map<java.lang.String,JsonData> params()

API name: params

script

@Nullable
public final Script script()

API name: script

timeZone

@Nullable
public final java.lang.String timeZone()

API name: time_zone

keyed

@Nullable
public final java.lang.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)

Class DateHistogramAggregation

Nested Class Summary

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

Field Summary