Package org.elasticsearch.client.ml.calendars

Class Calendar

java.lang.Object
org.elasticsearch.client.ml.calendars.Calendar
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class Calendar extends Object implements org.elasticsearch.common.xcontent.ToXContentObject
A simple calendar object for scheduled (special) events. The calendar consists of a name an a list of job Ids or job groups the events are stored separately and reference the calendar.

  • 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
    Modifier and Type
    Field
    Description
    static String
    CALENDAR_TYPE
     
    static org.elasticsearch.common.xcontent.ParseField
    DESCRIPTION
     
    static org.elasticsearch.common.xcontent.ParseField
    ID
     
    static org.elasticsearch.common.xcontent.ParseField
    JOB_IDS
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<Calendar,​Void>
    PARSER
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    Calendar​(String id, List<String> jobIds, String description)
    jobIds can be a mix of job groups and job Ids

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
    String
    getDescription()
     
    String
    getId()
     
    List<String>
    getJobIds()
     
    int
    hashCode()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    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

  • Field Details

    • CALENDAR_TYPE

      public static final String CALENDAR_TYPE
      See Also:
      Constant Field Values

    • JOB_IDS

      public static final org.elasticsearch.common.xcontent.ParseField JOB_IDS

    • ID

      public static final org.elasticsearch.common.xcontent.ParseField ID

    • DESCRIPTION

      public static final org.elasticsearch.common.xcontent.ParseField DESCRIPTION

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<Calendar,​Void> PARSER

  • Constructor Details

    • Calendar

      public Calendar​(String id, List<String> jobIds, @Nullable String description)
      jobIds can be a mix of job groups and job Ids
      Parameters:
      id - The calendar Id
      jobIds - List of job Ids or job groups
      description - An optional description

  • Method Details

    • getId

      public String getId()

    • getJobIds

      public List<String> getJobIds()

    • getDescription

      @Nullable public String getDescription()

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object