ScheduleIntervalTrigger¶

class oci.data_science.models.ScheduleIntervalTrigger(**kwargs)¶

Bases: oci.data_science.models.schedule_trigger.ScheduleTrigger

The interval schedule trigger.

Attributes

`FREQUENCY_DAILY`	A constant which can be used with the frequency property of a ScheduleIntervalTrigger.
`FREQUENCY_HOURLY`	A constant which can be used with the frequency property of a ScheduleIntervalTrigger.
`TRIGGER_TYPE_CRON`	str(object=’’) -> str
`TRIGGER_TYPE_ICAL`	str(object=’’) -> str
`TRIGGER_TYPE_INTERVAL`	str(object=’’) -> str
`frequency`	[Required] Gets the frequency of this ScheduleIntervalTrigger.
`initial_jitter_in_minutes`	Gets the initial_jitter_in_minutes of this ScheduleIntervalTrigger.
`interval`	[Required] Gets the interval of this ScheduleIntervalTrigger.
`is_random_start_time`	Gets the is_random_start_time of this ScheduleIntervalTrigger.
`time_end`	Gets the time_end of this ScheduleTrigger.
`time_start`	Gets the time_start of this ScheduleTrigger.
`trigger_type`	[Required] Gets the trigger_type of this ScheduleTrigger.

Methods

`__init__`(**kwargs)	Initializes a new ScheduleIntervalTrigger object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

FREQUENCY_DAILY = 'DAILY'¶: A constant which can be used with the frequency property of a ScheduleIntervalTrigger. This constant has a value of “DAILY”

FREQUENCY_HOURLY = 'HOURLY'¶: A constant which can be used with the frequency property of a ScheduleIntervalTrigger. This constant has a value of “HOURLY”

TRIGGER_TYPE_CRON = 'CRON'¶

TRIGGER_TYPE_ICAL = 'ICAL'¶

TRIGGER_TYPE_INTERVAL = 'INTERVAL'¶

__init__(**kwargs)¶

Initializes a new ScheduleIntervalTrigger object with values from keyword arguments. The default value of the trigger_type attribute of this class is INTERVAL and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

trigger_type (str) – The value to assign to the trigger_type property of this ScheduleIntervalTrigger. Allowed values for this property are: “CRON”, “INTERVAL”, “ICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_start (datetime) – The value to assign to the time_start property of this ScheduleIntervalTrigger.
time_end (datetime) – The value to assign to the time_end property of this ScheduleIntervalTrigger.
frequency (str) – The value to assign to the frequency property of this ScheduleIntervalTrigger. Allowed values for this property are: “HOURLY”, “DAILY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
interval (int) – The value to assign to the interval property of this ScheduleIntervalTrigger.
initial_jitter_in_minutes (int) – The value to assign to the initial_jitter_in_minutes property of this ScheduleIntervalTrigger.
is_random_start_time (bool) – The value to assign to the is_random_start_time property of this ScheduleIntervalTrigger.

frequency¶

[Required] Gets the frequency of this ScheduleIntervalTrigger. The type of frequency

Allowed values for this property are: “HOURLY”, “DAILY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The frequency of this ScheduleIntervalTrigger.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

initial_jitter_in_minutes¶

Gets the initial_jitter_in_minutes of this ScheduleIntervalTrigger. Maximum number of minutes after timeStart that the scheduler may use to randomly select the first execution time. This value is considered only when isRandomStartTime is true. This value applies only to the initial execution; subsequent executions remain deterministic based on the resolved first trigger time. If timeStart is null, the service resolves the effective start time using the current time. The initial jitter window is then applied once to that resolved start time to determine the first execution time. If not provided and isRandomStartTime is true, the service defaults the jitter window to half of the configured interval duration. The value must not exceed the configured interval duration.

Returns:	The initial_jitter_in_minutes of this ScheduleIntervalTrigger.
Return type:	int

interval¶

[Required] Gets the interval of this ScheduleIntervalTrigger. The interval of frequency.

Returns:	The interval of this ScheduleIntervalTrigger.
Return type:	int

is_random_start_time¶

Gets the is_random_start_time of this ScheduleIntervalTrigger. when true, system generates a randomized first start time between timeStart and timeStart + initialJitterInMinutes. if timeStart is null, the current time is used as the base start time.

Returns:	The is_random_start_time of this ScheduleIntervalTrigger.
Return type:	bool

time_end¶

Gets the time_end of this ScheduleTrigger. The schedule end date time, if null, the schedule will never expire. Format is defined by RFC3339.

Returns:	The time_end of this ScheduleTrigger.
Return type:	datetime

time_start¶

Gets the time_start of this ScheduleTrigger. The schedule starting date time, if null, System set the time when schedule is created. Format is defined by RFC3339.

Returns:	The time_start of this ScheduleTrigger.
Return type:	datetime

trigger_type¶

[Required] Gets the trigger_type of this ScheduleTrigger. The schedule trigger type

Allowed values for this property are: “CRON”, “INTERVAL”, “ICAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The trigger_type of this ScheduleTrigger.
Return type:	str