程序包 org.easysearch.client.rollup.job.config

类 DateHistogramGroupConfig

java.lang.Object

org.easysearch.client.rollup.job.config.DateHistogramGroupConfig

所有已实现的接口:

Validatable, org.easysearch.common.xcontent.ToXContent, org.easysearch.common.xcontent.ToXContentObject

直接已知子类:

DateHistogramGroupConfig.CalendarInterval, DateHistogramGroupConfig.FixedInterval

public class DateHistogramGroupConfig
extends java.lang.Object
implements Validatable, org.easysearch.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" } ] }

嵌套类概要

嵌套类

修饰符和类型	类	说明
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.

从接口继承的嵌套类/接口 org.easysearch.common.xcontent.ToXContent

org.easysearch.common.xcontent.ToXContent.DelegatingMapParams, org.easysearch.common.xcontent.ToXContent.MapParams, org.easysearch.common.xcontent.ToXContent.Params

字段概要

从接口继承的字段 org.easysearch.common.xcontent.ToXContent

EMPTY_PARAMS

从接口继承的字段 org.easysearch.client.Validatable

EMPTY

构造器概要

构造器

构造器	说明
DateHistogramGroupConfig(java.lang.String field, org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)	已过时。 Build a DateHistoConfig using DateHistogramGroupConfig.CalendarInterval or DateHistogramGroupConfig.FixedInterval instead
DateHistogramGroupConfig(java.lang.String field, org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval interval, org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval delay, java.lang.String timeZone)	已过时。 Build a DateHistoConfig using DateHistogramGroupConfig.CalendarInterval or DateHistogramGroupConfig.FixedInterval instead

方法概要

修饰符和类型	方法	说明
boolean	equals(java.lang.Object other)
static DateHistogramGroupConfig	fromXContent(org.easysearch.common.xcontent.XContentParser parser)
org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval	getDelay()	Get the time delay for this histogram
java.lang.String	getField()	Get the date field
org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval	getInterval()	Get the date interval
java.lang.String	getTimeZone()	Get the timezone to apply
int	hashCode()
org.easysearch.common.xcontent.XContentBuilder	toXContent(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params)
java.util.Optional<ValidationException>	validate()	Perform validation.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.easysearch.common.xcontent.ToXContentObject

isFragment

构造器详细资料

DateHistogramGroupConfig

@Deprecated
public DateHistogramGroupConfig(java.lang.String field,
org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval interval)

已过时。

Build a DateHistoConfig using DateHistogramGroupConfig.CalendarInterval or DateHistogramGroupConfig.FixedInterval instead

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

从以下版本开始:

7.2.0

DateHistogramGroupConfig

@Deprecated
public DateHistogramGroupConfig(java.lang.String field,
org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval interval,
@Nullable
org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval delay,
@Nullable
java.lang.String timeZone)

已过时。

Build a DateHistoConfig using DateHistogramGroupConfig.CalendarInterval or DateHistogramGroupConfig.FixedInterval instead

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.

参数:

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.

从以下版本开始:

7.2.0

方法详细资料

validate

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

从接口复制的说明: 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.

指定者:

validate 在接口中 Validatable

返回:

An Optional ValidationException that contains a list of validation errors.

getField

public java.lang.String getField()

Get the date field

getInterval

public org.easysearch.search.aggregations.bucket.histogram.DateHistogramInterval getInterval()

Get the date interval

getDelay

public org.easysearch.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.easysearch.common.xcontent.XContentBuilder toXContent(org.easysearch.common.xcontent.XContentBuilder builder,
org.easysearch.common.xcontent.ToXContent.Params params)
                                                          throws java.io.IOException

指定者:

toXContent 在接口中 org.easysearch.common.xcontent.ToXContent

抛出:

java.io.IOException

equals

public boolean equals(java.lang.Object other)

覆盖:

equals 在类中 java.lang.Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

fromXContent

public static DateHistogramGroupConfig fromXContent(org.easysearch.common.xcontent.XContentParser parser)
                                             throws java.io.IOException

抛出:

java.io.IOException