Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.rollup.job

Class DateHistogramGroupConfig

java.lang.Object

org.elasticsearch.xpack.core.rollup.job.DateHistogramGroupConfig

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Direct Known Subclasses:

DateHistogramGroupConfig.CalendarInterval, DateHistogramGroupConfig.FixedInterval

public abstract class DateHistogramGroupConfig
extends Object
implements Writeable, 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

Modifier and Type	Class	Description
static class	DateHistogramGroupConfig.CalendarInterval	CalendarInterval is a DateHistogramGroupConfig that uses calendar-aware intervals for rolling up data.
static class	DateHistogramGroupConfig.FixedInterval	FixedInterval is a DateHistogramGroupConfig that uses a fixed time interval for rolling up data.

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CALENDAR_INTERVAL
static final ZoneId	DEFAULT_ZONEID_TIMEZONE
static final String	DELAY
static final String	FIXED_INTERVAL
static final String	INTERVAL
static final String	TIME_ZONE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DateHistogramGroupConfig(String field, DateHistogramInterval interval, DateHistogramInterval delay, String timeZone)	Create a new DateHistogramGroupConfig using the given configuration parameters.
protected	DateHistogramGroupConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Rounding.Prepared	createRounding()	Create the rounding for this date histogram
boolean	equals(Object other)
static DateHistogramGroupConfig	fromXContent(XContentParser parser)
DateHistogramInterval	getDelay()	Get the time delay for this histogram
String	getField()	Get the date field
DateHistogramInterval	getInterval()	Get the date interval
String	getIntervalTypeName()
String	getTimeZone()	Get the timezone to apply
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	validateMappings(Map<String,Map<String,FieldCapabilities>> fieldCapsResponse, ActionRequestValidationException validationException)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

INTERVAL

public static final String INTERVAL

See Also:

• Constant Field Values

FIXED_INTERVAL

public static final String FIXED_INTERVAL

See Also:

• Constant Field Values

CALENDAR_INTERVAL

public static final String CALENDAR_INTERVAL

See Also:

• Constant Field Values

TIME_ZONE

public static final String TIME_ZONE

See Also:

• Constant Field Values

DELAY

public static final String DELAY

See Also:

• Constant Field Values

DEFAULT_ZONEID_TIMEZONE

public static final ZoneId DEFAULT_ZONEID_TIMEZONE

Constructor Details

DateHistogramGroupConfig

protected DateHistogramGroupConfig(String field,
 DateHistogramInterval interval,
 @Nullable
 DateHistogramInterval delay,
 @Nullable
 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 (ZoneId.of(String) and must match a time zone identifier.

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.

Since:

7.2.0

DateHistogramGroupConfig

protected DateHistogramGroupConfig(StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getField

public 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 String getTimeZone()

Get the timezone to apply

createRounding

public Rounding.Prepared createRounding()

Create the rounding for this date histogram

getIntervalTypeName

public String getIntervalTypeName()

validateMappings

public void validateMappings(Map<String,Map<String,FieldCapabilities>> fieldCapsResponse,
 ActionRequestValidationException validationException)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromXContent

public static DateHistogramGroupConfig fromXContent(XContentParser parser)
                                             throws IOException

Throws:

IOException