Class AutoDateHistogramAggregation.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<AutoDateHistogramAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.AutoDateHistogramAggregation.Builder
- All Implemented Interfaces:
WithJson<AutoDateHistogramAggregation.Builder>
,ObjectBuilder<AutoDateHistogramAggregation>
- Enclosing class:
- AutoDateHistogramAggregation
public static class AutoDateHistogramAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>
implements ObjectBuilder<AutoDateHistogramAggregation>
Builder for
AutoDateHistogramAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe target number of buckets.build()
Builds aAutoDateHistogramAggregation
.The field on which to run the aggregation.The date format used to formatkey_as_string
in the response.minimumInterval
(MinimumInterval value) The minimum rounding interval.The value to apply to documents that do not have a value.Time zone specified as a ISO 8601 UTC offset.API name:params
API name:params
API name:script
API name:script
protected AutoDateHistogramAggregation.Builder
self()
Time zone ID.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
-
buckets
The target number of buckets.API name:
buckets
-
field
The field on which to run the aggregation.API name:
field
-
format
The date format used to formatkey_as_string
in the response. If noformat
is specified, the first date format specified in the field mapping is used.API name:
format
-
minimumInterval
The minimum rounding interval. This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower thanminimum_interval
.API name:
minimum_interval
-
missing
The value to apply to documents that do not have a value. By default, documents without a value are ignored.API name:
missing
-
offset
Time zone specified as a ISO 8601 UTC offset.API name:
offset
-
params
API name:params
Adds all entries of
map
toparams
. -
params
API name:params
Adds an entry to
params
. -
script
API name:script
-
script
public final AutoDateHistogramAggregation.Builder script(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:script
-
timeZone
Time zone ID.API name:
time_zone
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<AutoDateHistogramAggregation.Builder>
-
build
Builds aAutoDateHistogramAggregation
.- Specified by:
build
in interfaceObjectBuilder<AutoDateHistogramAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-