Class DateRangeAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.DateRangeAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class DateRangeAggregation
extends BucketAggregationBase
implements AggregationVariant
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<DateRangeAggregation>
Json deserializer forDateRangeAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final String
field()
The date field whose values are use to build ranges.final String
format()
The date format used to formatfrom
andto
in the response.final Boolean
keyed()
Set totrue
to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.final FieldValue
missing()
The value to apply to documents that do not have a value.static DateRangeAggregation
final List<DateRangeExpression>
ranges()
Array of date ranges.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final String
timeZone()
Time zone used to convert dates from another time zone to UTC.Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forDateRangeAggregation
-
-
Method Details
-
of
public static DateRangeAggregation of(Function<DateRangeAggregation.Builder, ObjectBuilder<DateRangeAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
field
The date field whose values are use to build ranges.API name:
field
-
format
The date format used to formatfrom
andto
in the response.API name:
format
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
ranges
Array of date ranges.API name:
ranges
-
timeZone
Time zone used to convert dates from another time zone to UTC.API name:
time_zone
-
keyed
Set totrue
to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.API name:
keyed
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupDateRangeAggregationDeserializer
protected static void setupDateRangeAggregationDeserializer(ObjectDeserializer<DateRangeAggregation.Builder> op)
-