Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.calendars

Class ScheduledEvent

java.lang.Object

org.elasticsearch.xpack.core.ml.calendars.ScheduledEvent

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class ScheduledEvent
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScheduledEvent.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	DESCRIPTION
static final String	DOCUMENT_ID_PREFIX
static final ParseField	END_TIME
static final ParseField	EVENT_ID
static final ParseField	FORCE_TIME_SHIFT
static final ObjectParser<ScheduledEvent.Builder,Void>	LENIENT_PARSER
static final ParseField	RESULTS_FIELD
static final String	SCHEDULED_EVENT_TYPE
static final ParseField	SKIP_MODEL_UPDATE
static final ParseField	SKIP_RESULT
static final ParseField	START_TIME
static final ObjectParser<ScheduledEvent.Builder,Void>	STRICT_PARSER
static final ParseField	TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScheduledEvent(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static String	documentId(String eventId)
boolean	equals(Object obj)
String	getCalendarId()
String	getDescription()
Instant	getEndTime()
String	getEventId()
Integer	getForceTimeShift()
Boolean	getSkipModelUpdate()
Boolean	getSkipResult()
Instant	getStartTime()
int	hashCode()
DetectionRule	toDetectionRule(TimeValue bucketSpan)	Convert the scheduled event to a detection rule.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

Field Details

DESCRIPTION

public static final ParseField DESCRIPTION

START_TIME

public static final ParseField START_TIME

END_TIME

public static final ParseField END_TIME

SKIP_RESULT

public static final ParseField SKIP_RESULT

SKIP_MODEL_UPDATE

public static final ParseField SKIP_MODEL_UPDATE

FORCE_TIME_SHIFT

public static final ParseField FORCE_TIME_SHIFT

TYPE

public static final ParseField TYPE

EVENT_ID

public static final ParseField EVENT_ID

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

SCHEDULED_EVENT_TYPE

public static final String SCHEDULED_EVENT_TYPE

See Also:

• Constant Field Values

DOCUMENT_ID_PREFIX

public static final String DOCUMENT_ID_PREFIX

See Also:

• Constant Field Values

STRICT_PARSER

public static final ObjectParser<ScheduledEvent.Builder,Void> STRICT_PARSER

LENIENT_PARSER

public static final ObjectParser<ScheduledEvent.Builder,Void> LENIENT_PARSER

Constructor Details

ScheduledEvent

public ScheduledEvent(StreamInput in)
               throws IOException

Throws:

IOException

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(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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object