CronSchedule¶

class oci.log_analytics.models.CronSchedule(**kwargs)¶

Bases: oci.log_analytics.models.schedule.Schedule

Cron schedule for a scheduled task.

Attributes

`MISFIRE_POLICY_RETRY_INDEFINITELY`	str(object=’’) -> str
`MISFIRE_POLICY_RETRY_ONCE`	str(object=’’) -> str
`MISFIRE_POLICY_SKIP`	str(object=’’) -> str
`TYPE_AUTO`	str(object=’’) -> str
`TYPE_CRON`	str(object=’’) -> str
`TYPE_FIXED_FREQUENCY`	str(object=’’) -> str
`expression`	Gets the expression of this CronSchedule.
`misfire_policy`	Gets the misfire_policy of this Schedule.
`query_offset_secs`	Gets the query_offset_secs of this Schedule.
`time_end`	Gets the time_end of this Schedule.
`time_of_first_execution`	Gets the time_of_first_execution of this Schedule.
`time_zone`	Gets the time_zone of this CronSchedule.
`type`	[Required] Gets the type of this Schedule.

Methods

`__init__`(**kwargs)	Initializes a new CronSchedule 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.

MISFIRE_POLICY_RETRY_INDEFINITELY = 'RETRY_INDEFINITELY'¶

MISFIRE_POLICY_RETRY_ONCE = 'RETRY_ONCE'¶

MISFIRE_POLICY_SKIP = 'SKIP'¶

TYPE_AUTO = 'AUTO'¶

TYPE_CRON = 'CRON'¶

TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'¶

__init__(**kwargs)¶

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

Parameters:

type (str) – The value to assign to the type property of this CronSchedule. Allowed values for this property are: “FIXED_FREQUENCY”, “CRON”, “AUTO”
misfire_policy (str) – The value to assign to the misfire_policy property of this CronSchedule. Allowed values for this property are: “RETRY_ONCE”, “RETRY_INDEFINITELY”, “SKIP”
time_of_first_execution (datetime) – The value to assign to the time_of_first_execution property of this CronSchedule.
query_offset_secs (int) – The value to assign to the query_offset_secs property of this CronSchedule.
time_end (datetime) – The value to assign to the time_end property of this CronSchedule.
expression (str) – The value to assign to the expression property of this CronSchedule.
time_zone (str) – The value to assign to the time_zone property of this CronSchedule.

expression¶

Gets the expression of this CronSchedule. Value in cron format.

Returns:	The expression of this CronSchedule.
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.

misfire_policy¶

Gets the misfire_policy of this Schedule. Schedule misfire retry policy.

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

Returns:	The misfire_policy of this Schedule.
Return type:	str

query_offset_secs¶

Gets the query_offset_secs of this Schedule. Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs.

Returns:	The query_offset_secs of this Schedule.
Return type:	int

time_end¶

Gets the time_end of this Schedule. End time for the schedule, even if the schedule would otherwise have remaining executions.

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

time_of_first_execution¶

Gets the time_of_first_execution of this Schedule. The date and time the scheduled task should execute first time after create or update; thereafter the task will execute as specified in the schedule.

Returns:	The time_of_first_execution of this Schedule.
Return type:	datetime

time_zone¶

Gets the time_zone of this CronSchedule. Time zone, by default UTC.

Returns:	The time_zone of this CronSchedule.
Return type:	str

type¶

[Required] Gets the type of this Schedule. Schedule type discriminator.

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

Returns:	The type of this Schedule.
Return type:	str