Class RangeAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<RangeAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.RangeAggregation.Builder
- All Implemented Interfaces:
WithJson<RangeAggregation.Builder>
,ObjectBuilder<RangeAggregation>
- Enclosing class:
- RangeAggregation
public static class RangeAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<RangeAggregation.Builder>
implements ObjectBuilder<RangeAggregation>
Builder for
RangeAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aRangeAggregation
.final RangeAggregation.Builder
The date field whose values are use to build ranges.final RangeAggregation.Builder
API name:format
final RangeAggregation.Builder
Set totrue
to associate a unique string key with each bucket and return the ranges as a hash rather than an array.final RangeAggregation.Builder
The value to apply to documents that do not have a value.final RangeAggregation.Builder
ranges
(AggregationRange value, AggregationRange... values) An array of ranges used to bucket documents.final RangeAggregation.Builder
An array of ranges used to bucket documents.final RangeAggregation.Builder
ranges
(List<AggregationRange> list) An array of ranges used to bucket documents.final RangeAggregation.Builder
API name:script
final RangeAggregation.Builder
API name:script
protected RangeAggregation.Builder
self()
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toranges
. -
ranges
An array of ranges used to bucket documents.API name:
ranges
Adds one or more values to
ranges
. -
ranges
public final RangeAggregation.Builder ranges(Function<AggregationRange.Builder, ObjectBuilder<AggregationRange>> fn) An array of ranges used to bucket documents.API name:
ranges
Adds a value to
ranges
using a builder lambda. -
script
API name:script
-
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
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<RangeAggregation.Builder>
-
build
Builds aRangeAggregation
.- Specified by:
build
in interfaceObjectBuilder<RangeAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-