Module org.elasticsearch.xcore
Class ScheduledEvent
java.lang.Object
org.elasticsearch.xpack.core.ml.calendars.ScheduledEvent
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldstatic final Stringstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ObjectParser<ScheduledEvent.Builder, Void> static final org.elasticsearch.xcontent.ParseFieldstatic final Stringstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ObjectParser<ScheduledEvent.Builder, Void> static final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringdocumentId(String eventId) booleaninthashCode()toDetectionRule(org.elasticsearch.core.TimeValue bucketSpan) Convert the scheduled event to a detection rule.org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
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
- See Also:
-
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
-
ScheduledEvent
- Throws:
IOException
-
-
Method Details
-
documentId
-
getDescription
-
getStartTime
-
getEndTime
-
getCalendarId
-
getSkipResult
-
getSkipModelUpdate
-
getForceTimeShift
-
getEventId
-
toDetectionRule
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
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-