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

Class RollupJobConfig

java.lang.Object

org.elasticsearch.client.rollup.job.config.RollupJobConfig

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class RollupJobConfig
extends Object
implements Validatable, ToXContentObject

This class holds the configuration details of a rollup job, such as the groupings, metrics, what index to rollup and where to roll them to.

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
RollupJobConfig(String id, String indexPattern, String rollupIndex, String cron, int pageSize, GroupConfig groupConfig, List<MetricConfig> metricsConfig, TimeValue timeout)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static RollupJobConfig	fromXContent(XContentParser parser, String optionalJobId)
String	getCron()
GroupConfig	getGroupConfig()
String	getId()
String	getIndexPattern()
List<MetricConfig>	getMetricsConfig()
int	getPageSize()
String	getRollupIndex()
TimeValue	getTimeout()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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

RollupJobConfig

public RollupJobConfig(String id,
                       String indexPattern,
                       String rollupIndex,
                       String cron,
                       int pageSize,
                       GroupConfig groupConfig,
                       List<MetricConfig> metricsConfig,
                       @Nullable
                       TimeValue timeout)

Method Detail

validate

public 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.

getId

public String getId()

getGroupConfig

public GroupConfig getGroupConfig()

getMetricsConfig

public List<MetricConfig> getMetricsConfig()

getTimeout

public TimeValue getTimeout()

getIndexPattern

public String getIndexPattern()

getRollupIndex

public String getRollupIndex()

getCron

public String getCron()

getPageSize

public int getPageSize()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromXContent

public static RollupJobConfig fromXContent(XContentParser parser,
                                           @Nullable
                                           String optionalJobId)
                                    throws IOException

Throws:

IOException