Package org.elasticsearch.client.rollup.job.config

Class DateHistogramGroupConfig

java.lang.Object

org.elasticsearch.client.rollup.job.config.DateHistogramGroupConfig

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class DateHistogramGroupConfig
extends java.lang.Object
implements Validatable, ToXContentObject

The configuration object for the histograms in the rollup config { "groups": [ "date_histogram": { "field" : "foo", "interval" : "1d", "delay": "30d", "time_zone" : "EST" } ] }

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
DateHistogramGroupConfig(java.lang.String field, DateHistogramInterval interval)	Create a new DateHistogramGroupConfig using the given field and interval parameters.
DateHistogramGroupConfig(java.lang.String field, DateHistogramInterval interval, DateHistogramInterval delay, java.lang.String timeZone)	Create a new DateHistogramGroupConfig using the given configuration parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
static DateHistogramGroupConfig	fromXContent(XContentParser parser)
DateHistogramInterval	getDelay()	Get the time delay for this histogram
java.lang.String	getField()	Get the date field
DateHistogramInterval	getInterval()	Get the date interval
java.lang.String	getTimeZone()	Get the timezone to apply
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.util.Optional<ValidationException>	validate()	Perform validation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Constructor Detail

DateHistogramGroupConfig

public DateHistogramGroupConfig(java.lang.String field,
                                DateHistogramInterval interval)

Create a new DateHistogramGroupConfig using the given field and interval parameters.

DateHistogramGroupConfig

public DateHistogramGroupConfig(java.lang.String field,
                                DateHistogramInterval interval,
                                @Nullable
                                DateHistogramInterval delay,
                                @Nullable
                                java.lang.String timeZone)

Create a new DateHistogramGroupConfig using the given configuration parameters.

The field and interval are required to compute the date histogram for the rolled up documents. The delay is optional and can be set to null. It defines how long to wait before rolling up new documents. The timeZone is optional and can be set to null. When configured, the time zone value is resolved using (DateTimeZone.forID(String) and must match a time zone identifier provided by the Joda Time library.

Parameters:

field - the name of the date field to use for the date histogram (required)

interval - the interval to use for the date histogram (required)

delay - the time delay (optional)

timeZone - the id of time zone to use to calculate the date histogram (optional). When null, the UTC timezone is used.

Method Detail

validate

public java.util.Optional<ValidationException> validate()

Description copied from interface: Validatable

Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.

Specified by:

validate in interface Validatable

Returns:

An Optional ValidationException that contains a list of validation errors.

getField

public java.lang.String getField()

Get the date field

getInterval

public DateHistogramInterval getInterval()

Get the date interval

getDelay

public DateHistogramInterval getDelay()

Get the time delay for this histogram

getTimeZone

public java.lang.String getTimeZone()

Get the timezone to apply

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromXContent

public static DateHistogramGroupConfig fromXContent(XContentParser parser)
                                             throws java.io.IOException

Throws:

java.io.IOException