Module org.elasticsearch.xcore

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

Class RollupJobConfig

java.lang.Object

org.elasticsearch.xpack.core.rollup.job.RollupJobConfig

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject

public class RollupJobConfig
extends Object
implements NamedWriteable, 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.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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RollupJobConfig(String id, String indexPattern, String rollupIndex, String cron, int pageSize, GroupConfig groupConfig, List<MetricConfig> metricsConfig, TimeValue timeout)
RollupJobConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
static RollupJobConfig	fromXContent(XContentParser parser, String optionalJobId)
Set<String>	getAllFields()
String	getCron()
GroupConfig	getGroupConfig()
String	getId()
String	getIndexPattern()
List<MetricConfig>	getMetricsConfig()
int	getPageSize()
String	getRollupIndex()
TimeValue	getTimeout()
String	getWriteableName()
int	hashCode()
String[]	indices()
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

Constructor Details

RollupJobConfig

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

RollupJobConfig

public RollupJobConfig(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

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()

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

getAllFields

public Set<String> getAllFields()

indices

public String[] indices()

validateMappings

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

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 RollupJobConfig fromXContent(XContentParser parser,
 @Nullable
 String optionalJobId)
                                    throws IOException

Throws:

IOException