java.lang.Object
org.elasticsearch.xpack.core.ml.calendars.ScheduledEvent
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public class ScheduledEvent extends Object implements org.elasticsearch.xcontent.ToXContentObject, Writeable
  • Field Details

    • DESCRIPTION

      public static final org.elasticsearch.xcontent.ParseField DESCRIPTION
    • START_TIME

      public static final org.elasticsearch.xcontent.ParseField START_TIME
    • END_TIME

      public static final org.elasticsearch.xcontent.ParseField END_TIME
    • SKIP_RESULT

      public static final org.elasticsearch.xcontent.ParseField SKIP_RESULT
    • SKIP_MODEL_UPDATE

      public static final org.elasticsearch.xcontent.ParseField SKIP_MODEL_UPDATE
    • FORCE_TIME_SHIFT

      public static final org.elasticsearch.xcontent.ParseField FORCE_TIME_SHIFT
    • TYPE

      public static final org.elasticsearch.xcontent.ParseField TYPE
    • EVENT_ID

      public static final org.elasticsearch.xcontent.ParseField EVENT_ID
    • RESULTS_FIELD

      public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD
    • SCHEDULED_EVENT_TYPE

      public static final String SCHEDULED_EVENT_TYPE
      See Also:
    • DOCUMENT_ID_PREFIX

      public static final String DOCUMENT_ID_PREFIX
      See Also:
    • STRICT_PARSER

      public static final org.elasticsearch.xcontent.ObjectParser<ScheduledEvent.Builder,Void> STRICT_PARSER
    • LENIENT_PARSER

      public static final org.elasticsearch.xcontent.ObjectParser<ScheduledEvent.Builder,Void> LENIENT_PARSER
  • Constructor Details

  • Method Details

    • documentId

      public static String documentId(String eventId)
    • getDescription

      public String getDescription()
    • getStartTime

      public Instant getStartTime()
    • getEndTime

      public Instant getEndTime()
    • getCalendarId

      public String getCalendarId()
    • getSkipResult

      public Boolean getSkipResult()
    • getSkipModelUpdate

      public Boolean getSkipModelUpdate()
    • getForceTimeShift

      public Integer getForceTimeShift()
    • getEventId

      public String getEventId()
    • toDetectionRule

      public DetectionRule toDetectionRule(org.elasticsearch.core.TimeValue bucketSpan)
      Convert the scheduled event to a detection rule. The rule will have 2 time based conditions for the start and end of the event. The rule's start and end times are aligned with the bucket span so the start time is rounded down to a bucket interval and the end time rounded up.
      Parameters:
      bucketSpan - Bucket span to align to
      Returns:
      The event as a detection rule.
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • toXContent

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

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object