Class RangeAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.RangeAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable
public class RangeAggregation
extends BucketAggregationBase
implements AggregationVariant
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<RangeAggregation>
Json deserializer forRangeAggregation
-
Method Summary
Modifier and TypeMethodDescriptionAggregation variant kind.final String
field()
The date field whose values are use to build ranges.final String
format()
API name:format
final Boolean
keyed()
Set totrue
to associate a unique string key with each bucket and return the ranges as a hash rather than an array.final Integer
missing()
The value to apply to documents that do not have a value.static RangeAggregation
final List<AggregationRange>
ranges()
An array of ranges used to bucket documents.final Script
script()
API name:script
protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
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 forRangeAggregation
-
-
Method Details
-
of
public static RangeAggregation of(Function<RangeAggregation.Builder, ObjectBuilder<RangeAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
field
The date field whose values are use to build ranges.API name:
field
-
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
An array of ranges used to bucket documents.API name:
ranges
-
script
API name:script
-
keyed
Set totrue
to associate a unique string key with each bucket and return the ranges as a hash rather than an array.API name:
keyed
-
format
API name:format
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupRangeAggregationDeserializer
protected static void setupRangeAggregationDeserializer(ObjectDeserializer<RangeAggregation.Builder> op)
-