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

Class AutoDateHistogramAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

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

org.opensearch.client.opensearch._types.aggregations.AutoDateHistogramAggregation

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<AutoDateHistogramAggregation.Builder,AutoDateHistogramAggregation>

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

Nested Class Summary

Nested Classes

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

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<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.
static AutoDateHistogramAggregation.Builder	builder()
boolean	equals(Object o)
final String	field()	API name: field
final String	format()	The date format used to format key_as_string in the response.
int	hashCode()
final MinimumInterval	minimumInterval()	API name: minimum_interval
final String	missing()	API name: missing
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()	API name: time_zone
AutoDateHistogramAggregation.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<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()

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

API name: minimum_interval

missing

@Nullable
public final String missing()

API name: missing

offset

@Nullable
public final String offset()

Time zone specified as a ISO 8601 UTC offset.

API name: offset

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 AutoDateHistogramAggregation.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<AutoDateHistogramAggregation.Builder,AutoDateHistogramAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static AutoDateHistogramAggregation.Builder builder()

setupAutoDateHistogramAggregationDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase