Class RollupJobConfig

java.lang.Object
org.elasticsearch.client.rollup.job.config.RollupJobConfig
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public class RollupJobConfig
extends java.lang.Object
implements Validatable, org.elasticsearch.common.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.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
    RollupJobConfig​(java.lang.String id, java.lang.String indexPattern, java.lang.String rollupIndex, java.lang.String cron, int pageSize, GroupConfig groupConfig, java.util.List<MetricConfig> metricsConfig, org.elasticsearch.common.unit.TimeValue timeout)  
  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object other)  
    static RollupJobConfig fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String optionalJobId)  
    java.lang.String getCron()  
    GroupConfig getGroupConfig()  
    java.lang.String getId()  
    java.lang.String getIndexPattern()  
    java.util.List<MetricConfig> getMetricsConfig()  
    int getPageSize()  
    java.lang.String getRollupIndex()  
    org.elasticsearch.common.unit.TimeValue getTimeout()  
    int 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

    • RollupJobConfig

      public RollupJobConfig​(java.lang.String id, java.lang.String indexPattern, java.lang.String rollupIndex, java.lang.String cron, int pageSize, GroupConfig groupConfig, java.util.List<MetricConfig> metricsConfig, @Nullable org.elasticsearch.common.unit.TimeValue timeout)
  • Method Details

    • validate

      public java.util.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 java.lang.String getId()
    • getGroupConfig

      public GroupConfig getGroupConfig()
    • getMetricsConfig

      public java.util.List<MetricConfig> getMetricsConfig()
    • getTimeout

      public org.elasticsearch.common.unit.TimeValue getTimeout()
    • getIndexPattern

      public java.lang.String getIndexPattern()
    • getRollupIndex

      public java.lang.String getRollupIndex()
    • getCron

      public java.lang.String getCron()
    • getPageSize

      public int getPageSize()
    • 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 interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • equals

      public boolean equals​(java.lang.Object other)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • fromXContent

      public static RollupJobConfig fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser, @Nullable java.lang.String optionalJobId) throws java.io.IOException
      Throws:
      java.io.IOException