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

Class DateRangeAggregation

java.lang.Object

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

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

org.opensearch.client.opensearch._types.aggregations.DateRangeAggregation

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static DateRangeAggregation.Builder	builder()
boolean	equals(Object o)
final String	field()	API name: field
final String	format()	The date format used to format from and to in the response.
int	hashCode()
final Boolean	keyed()	Set to true to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.
final FieldValue	missing()	API name: missing
static DateRangeAggregation	of(Function<DateRangeAggregation.Builder,ObjectBuilder<DateRangeAggregation>> fn)
final List<DateRangeExpression>	ranges()	Array of date ranges.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op)
final String	timeZone()	API name: time_zone
DateRangeAggregation.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<DateRangeAggregation> _DESERIALIZER

Json deserializer for DateRangeAggregation

Method Details

of

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

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

field

@Nullable
public final String field()

API name: field

format

@Nullable
public final String format()

The date format used to format from and to in the response.

API name: format

keyed

@Nullable
public final Boolean keyed()

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

API name: keyed

missing

@Nullable
public final FieldValue missing()

API name: missing

ranges

@Nonnull
public final List<DateRangeExpression> ranges()

Array of date ranges.

API name: ranges

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

Returns:

a new builder instance.

builder

@Nonnull
public static DateRangeAggregation.Builder builder()

setupDateRangeAggregationDeserializer

protected static void setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class BucketAggregationBase