Class DateHistogramGrouping.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DateHistogramGrouping.Builder>
co.elastic.clients.elasticsearch.rollup.DateHistogramGrouping.Builder
- All Implemented Interfaces:
WithJson<DateHistogramGrouping.Builder>
,ObjectBuilder<DateHistogramGrouping>
- Enclosing class:
- DateHistogramGrouping
public static class DateHistogramGrouping.Builder
extends WithJsonObjectBuilderBase<DateHistogramGrouping.Builder>
implements ObjectBuilder<DateHistogramGrouping>
Builder for
DateHistogramGrouping
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aDateHistogramGrouping
.calendarInterval
(Time value) The interval of time buckets to be generated when rolling up.The interval of time buckets to be generated when rolling up.How long to wait before rolling up new documents.How long to wait before rolling up new documents.Required - The date field that is to be rolled up.fixedInterval
(Time value) The interval of time buckets to be generated when rolling up.The interval of time buckets to be generated when rolling up.API name:format
API name:interval
API name:interval
protected DateHistogramGrouping.Builder
self()
Defines whattime_zone
the rollup documents are stored as.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
-
delay
How long to wait before rolling up new documents. By default, the indexer attempts to roll up all data that is available. However, it is not uncommon for data to arrive out of order. The indexer is unable to deal with data that arrives after a time-span has been rolled up. You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.API name:
delay
-
delay
How long to wait before rolling up new documents. By default, the indexer attempts to roll up all data that is available. However, it is not uncommon for data to arrive out of order. The indexer is unable to deal with data that arrives after a time-span has been rolled up. You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.API name:
delay
-
field
Required - The date field that is to be rolled up.API name:
field
-
format
API name:format
-
interval
API name:interval
-
interval
API name:interval
-
calendarInterval
The interval of time buckets to be generated when rolling up.API name:
calendar_interval
-
calendarInterval
public final DateHistogramGrouping.Builder calendarInterval(Function<Time.Builder, ObjectBuilder<Time>> fn) The interval of time buckets to be generated when rolling up.API name:
calendar_interval
-
fixedInterval
The interval of time buckets to be generated when rolling up.API name:
fixed_interval
-
fixedInterval
public final DateHistogramGrouping.Builder fixedInterval(Function<Time.Builder, ObjectBuilder<Time>> fn) The interval of time buckets to be generated when rolling up.API name:
fixed_interval
-
timeZone
Defines whattime_zone
the rollup documents are stored as. Unlike raw data, which can shift timezones on the fly, rolled documents have to be stored with a specific timezone. By default, rollup documents are stored inUTC
.API name:
time_zone
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<DateHistogramGrouping.Builder>
-
build
Builds aDateHistogramGrouping
.- Specified by:
build
in interfaceObjectBuilder<DateHistogramGrouping>
- Throws:
NullPointerException
- if some of the required fields are null.
-