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

Class DateHistogramAggregation

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, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class DateHistogramAggregation
extends BucketAggregationBase
implements AggregationVariant, ToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation>

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static DateHistogramAggregation.Builder	builder()
final CalendarInterval	calendarInterval()	API name: calendar_interval
boolean	equals(Object o)
final ExtendedBounds<FieldDateMath>	extendedBounds()	API name: extended_bounds
final String	field()	API name: field
final Time	fixedInterval()	API name: fixed_interval
final String	format()	The date format used to format key_as_string in the response.
final ExtendedBounds<FieldDateMath>	hardBounds()	API name: hard_bounds
int	hashCode()
final Time	interval()	API name: interval
final Boolean	keyed()	Set to true to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
final Integer	minDocCount()	Only returns buckets that have min_doc_count number of documents.
final String	missing()	API name: missing
static DateHistogramAggregation	of(Function<DateHistogramAggregation.Builder,ObjectBuilder<DateHistogramAggregation>> fn)
final Time	offset()	API name: offset
final HistogramOrder	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
DateHistogramAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

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

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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

calendarInterval

@Nullable
public final CalendarInterval calendarInterval()

API name: calendar_interval

extendedBounds

@Nullable
public final ExtendedBounds<FieldDateMath> extendedBounds()

API name: extended_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()

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

hardBounds

@Nullable
public final ExtendedBounds<FieldDateMath> hardBounds()

API name: hard_bounds

interval

@Nullable
public final Time interval()

API name: interval

keyed

@Nullable
public final Boolean keyed()

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

API name: keyed

minDocCount

@Nullable
public final Integer minDocCount()

Only returns buckets that have min_doc_count number of documents. By default, all buckets between the first bucket that matches documents and the last one are returned.

API name: min_doc_count

missing

@Nullable
public final String missing()

API name: missing

offset

@Nullable
public final Time offset()

API name: offset

order

@Nullable
public final HistogramOrder order()

API name: order

params

@Nonnull
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

serializeInternal

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

Overrides:

serializeInternal in class AggregationBase

toBuilder

@Nonnull
public DateHistogramAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DateHistogramAggregation.Builder,DateHistogramAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static DateHistogramAggregation.Builder builder()

setupDateHistogramAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase