Package org.elasticsearch.client.dataframe.transforms.pivot

Class DateHistogramGroupSource.Builder

java.lang.Object

org.elasticsearch.client.dataframe.transforms.pivot.DateHistogramGroupSource.Builder

Enclosing class:

DateHistogramGroupSource

public static class DateHistogramGroupSource.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateHistogramGroupSource	build()
DateHistogramGroupSource.Builder	setField(java.lang.String field)	The field with which to construct the date histogram grouping
DateHistogramGroupSource.Builder	setFormat(java.lang.String format)	Set the optional String formatting for the time interval.
DateHistogramGroupSource.Builder	setInterval(DateHistogramGroupSource.Interval interval)	Set the interval for the DateHistogram grouping
DateHistogramGroupSource.Builder	setTimeZone(java.time.ZoneId timeZone)	Sets the time zone to use for this aggregation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setField

public DateHistogramGroupSource.Builder setField(java.lang.String field)

The field with which to construct the date histogram grouping

Parameters:

field - The field name

Returns:

The DateHistogramGroupSource.Builder with the field set.

setInterval

public DateHistogramGroupSource.Builder setInterval(DateHistogramGroupSource.Interval interval)

Set the interval for the DateHistogram grouping

Parameters:

interval - a fixed or calendar interval

Returns:

the DateHistogramGroupSource.Builder with the interval set.

setFormat

public DateHistogramGroupSource.Builder setFormat(java.lang.String format)

Set the optional String formatting for the time interval.

Parameters:

format - The format of the output for the time interval key

Returns:

The DateHistogramGroupSource.Builder with the format set.

setTimeZone

public DateHistogramGroupSource.Builder setTimeZone(java.time.ZoneId timeZone)

Sets the time zone to use for this aggregation

Parameters:

timeZone - The zoneId for the timeZone

Returns:

The DateHistogramGroupSource.Builder with the timeZone set.

build

public DateHistogramGroupSource build()