Class DateHistogramGroupConfig
java.lang.Object
org.elasticsearch.client.rollup.job.config.DateHistogramGroupConfig
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
- Direct Known Subclasses:
DateHistogramGroupConfig.CalendarInterval
,DateHistogramGroupConfig.FixedInterval
public class DateHistogramGroupConfig extends java.lang.Object implements Validatable, org.elasticsearch.common.xcontent.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 aDateHistogramGroupConfig
that uses calendar-aware intervals for rolling up data.static class
DateHistogramGroupConfig.FixedInterval
FixedInterval is aDateHistogramGroupConfig
that uses a fixed time interval for rolling up data.Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)
Deprecated.DateHistogramGroupConfig(java.lang.String field, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval delay, java.lang.String timeZone)
Deprecated.Build a DateHistoConfig usingDateHistogramGroupConfig.CalendarInterval
orDateHistogramGroupConfig.FixedInterval
instead -
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static DateHistogramGroupConfig
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval
getDelay()
Get the time delay for this histogramjava.lang.String
getField()
Get the date fieldorg.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval
getInterval()
Get the date intervaljava.lang.String
getTimeZone()
Get the timezone to applyint
hashCode()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details
-
DateHistogramGroupConfig
@Deprecated public DateHistogramGroupConfig(java.lang.String field, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)Deprecated.Build a DateHistoConfig usingDateHistogramGroupConfig.CalendarInterval
orDateHistogramGroupConfig.FixedInterval
insteadCreate a newDateHistogramGroupConfig
using the given field and interval parameters.- Since:
- 7.2.0
-
DateHistogramGroupConfig
@Deprecated public DateHistogramGroupConfig(java.lang.String field, org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval interval, @Nullable org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval delay, @Nullable java.lang.String timeZone)Deprecated.Build a DateHistoConfig usingDateHistogramGroupConfig.CalendarInterval
orDateHistogramGroupConfig.FixedInterval
insteadCreate a newDateHistogramGroupConfig
using the given configuration parameters.The
field
andinterval
are required to compute the date histogram for the rolled up documents. Thedelay
is optional and can be set tonull
. It defines how long to wait before rolling up new documents. ThetimeZone
is optional and can be set tonull
. 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). Whennull
, the UTC timezone is used.- Since:
- 7.2.0
-
-
Method Details
-
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. AValidationException
that is not null is assumed to contain validation errors and will be thrown.- Specified by:
validate
in interfaceValidatable
- Returns:
- An
Optional
ValidationException
that contains a list of validation errors.
-
getField
public java.lang.String getField()Get the date field -
getInterval
public org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval getInterval()Get the date interval -
getDelay
public org.elasticsearch.search.aggregations.bucket.histogram.DateHistogramInterval getDelay()Get the time delay for this histogram -
getTimeZone
public java.lang.String getTimeZone()Get the timezone to apply -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object other)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
fromXContent
public static DateHistogramGroupConfig fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
DateHistogramGroupConfig.CalendarInterval
orDateHistogramGroupConfig.FixedInterval
instead