Schedule¶
- class oci.log_analytics.models.Schedule(**kwargs)¶
Bases:
objectSchedule for scheduled task.
Attributes:
A constant which can be used with the misfire_policy property of a Schedule.
A constant which can be used with the misfire_policy property of a Schedule.
A constant which can be used with the misfire_policy property of a Schedule.
A constant which can be used with the type property of a Schedule.
A constant which can be used with the type property of a Schedule.
A constant which can be used with the type property of a Schedule.
Gets the misfire_policy of this Schedule.
Gets the query_offset_secs of this Schedule.
Gets the time_end of this Schedule.
Gets the time_of_first_execution of this Schedule.
[Required] Gets the type of this Schedule.
Methods:
__init__(**kwargs)Initializes a new Schedule 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'¶
A constant which can be used with the misfire_policy property of a Schedule. This constant has a value of “RETRY_INDEFINITELY”
- MISFIRE_POLICY_RETRY_ONCE = 'RETRY_ONCE'¶
A constant which can be used with the misfire_policy property of a Schedule. This constant has a value of “RETRY_ONCE”
- MISFIRE_POLICY_SKIP = 'SKIP'¶
A constant which can be used with the misfire_policy property of a Schedule. This constant has a value of “SKIP”
- TYPE_AUTO = 'AUTO'¶
A constant which can be used with the type property of a Schedule. This constant has a value of “AUTO”
- TYPE_CRON = 'CRON'¶
A constant which can be used with the type property of a Schedule. This constant has a value of “CRON”
- TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'¶
A constant which can be used with the type property of a Schedule. This constant has a value of “FIXED_FREQUENCY”
- __init__(**kwargs)¶
Initializes a new Schedule object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 Schedule. 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’.
misfire_policy (str) – The value to assign to the misfire_policy property of this Schedule. 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’.
time_of_first_execution (datetime) – The value to assign to the time_of_first_execution property of this Schedule.
query_offset_secs (int) – The value to assign to the query_offset_secs property of this Schedule.
time_end (datetime) – The value to assign to the time_end property of this Schedule.
- 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.
- property 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
- property 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
- property 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
- property 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
- property 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