Class RollupJobConfig
java.lang.Object
org.elasticsearch.client.rollup.job.config.RollupJobConfig
- All Implemented Interfaces:
Validatable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public class RollupJobConfig
extends Object
implements Validatable, org.elasticsearch.xcontent.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
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
ConstructorDescriptionRollupJobConfig
(String id, String indexPattern, String rollupIndex, String cron, int pageSize, GroupConfig groupConfig, List<MetricConfig> metricsConfig, org.elasticsearch.core.TimeValue timeout) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static RollupJobConfig
fromXContent
(org.elasticsearch.xcontent.XContentParser parser, String optionalJobId) getCron()
getId()
int
org.elasticsearch.core.TimeValue
int
hashCode()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) 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.xcontent.ToXContentObject
isFragment
-
Constructor Details
-
RollupJobConfig
public RollupJobConfig(String id, String indexPattern, String rollupIndex, String cron, int pageSize, GroupConfig groupConfig, List<MetricConfig> metricsConfig, @Nullable org.elasticsearch.core.TimeValue timeout)
-
-
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.
-
getId
-
getGroupConfig
-
getMetricsConfig
-
getTimeout
public org.elasticsearch.core.TimeValue getTimeout() -
getIndexPattern
-
getRollupIndex
-
getCron
-
getPageSize
public int getPageSize() -
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode() -
fromXContent
public static RollupJobConfig fromXContent(org.elasticsearch.xcontent.XContentParser parser, @Nullable String optionalJobId) throws IOException - Throws:
IOException
-