Package org.opensearch.client.opensearch._types.aggregations

Class DateHistogramAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

org.opensearch.client.opensearch._types.aggregations.DateHistogramAggregation

All Implemented Interfaces:

ToJsonp

public final class DateHistogramAggregation
extends BucketAggregationBase

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DateHistogramAggregation(DateHistogramAggregation.Builder builder)

Method Summary

Modifier and Type	Method	Description
jakarta.json.JsonValue	calendarInterval()	API name: calendar_interval
ExtendedBounds<jakarta.json.JsonValue>	extendedBounds()	API name: extended_bounds
java.lang.String	field()	API name: field
jakarta.json.JsonValue	fixedInterval()	API name: fixed_interval
java.lang.String	format()	API name: format
ExtendedBounds<jakarta.json.JsonValue>	hardBounds()	API name: hard_bounds
jakarta.json.JsonValue	interval()	API name: interval
java.lang.Number	minDocCount()	API name: min_doc_count
java.lang.String	missing()	API name: missing
jakarta.json.JsonValue	offset()	API name: offset
HistogramOrder	order()	API name: order
java.util.Map<java.lang.String,jakarta.json.JsonValue>	params()	API name: params
jakarta.json.JsonValue	script()	API name: script
protected static void	setupDateHistogramAggregationDeserializer(DelegatingDeserializer<DateHistogramAggregation.Builder> op)
java.lang.String	timeZone()	API name: time_zone
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase

aggregations, setupBucketAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.Aggregation

meta, name, setupAggregationDeserializer, toJsonp

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<DateHistogramAggregation> DESERIALIZER

Json deserializer for DateHistogramAggregation

Constructor Details

DateHistogramAggregation

protected DateHistogramAggregation(DateHistogramAggregation.Builder builder)

Method Details

calendarInterval

@Nullable public jakarta.json.JsonValue calendarInterval()

API name: calendar_interval

extendedBounds

@Nullable public ExtendedBounds<jakarta.json.JsonValue> extendedBounds()

API name: extended_bounds

hardBounds

@Nullable public ExtendedBounds<jakarta.json.JsonValue> hardBounds()

API name: hard_bounds

field

@Nullable public java.lang.String field()

API name: field

fixedInterval

@Nullable public jakarta.json.JsonValue fixedInterval()

API name: fixed_interval

format

@Nullable public java.lang.String format()

API name: format

interval

@Nullable public jakarta.json.JsonValue interval()

API name: interval

minDocCount

@Nullable public java.lang.Number minDocCount()

API name: min_doc_count

missing

@Nullable public java.lang.String missing()

API name: missing

offset

@Nullable public jakarta.json.JsonValue offset()

API name: offset

order

@Nullable public HistogramOrder order()

API name: order

params

@Nullable public java.util.Map<java.lang.String,jakarta.json.JsonValue> params()

API name: params

script

@Nullable public jakarta.json.JsonValue script()

API name: script

timeZone

@Nullable public java.lang.String timeZone()

API name: time_zone

toJsonpInternal

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

Overrides:

toJsonpInternal in class BucketAggregationBase

setupDateHistogramAggregationDeserializer

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