ScheduledTask¶

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

Bases: object

Log analytics scheduled task resource.

Attributes

`KIND_ACCELERATION`	A constant which can be used with the kind property of a ScheduledTask.
`KIND_STANDARD`	A constant which can be used with the kind property of a ScheduledTask.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ScheduledTask.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ScheduledTask.
`PAUSE_REASON_METRIC_EXTRACTION_NOT_VALID`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_PURGE_RESOURCE_NOT_FOUND`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_QUERY_STRING_NOT_VALID`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_SAVED_SEARCH_NOT_FOUND`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_SAVED_SEARCH_NOT_VALID`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_TENANCY_LIFECYCLE`	A constant which can be used with the pause_reason property of a ScheduledTask.
`PAUSE_REASON_USER_ACTION`	A constant which can be used with the pause_reason property of a ScheduledTask.
`TASK_STATUS_BLOCKED`	A constant which can be used with the task_status property of a ScheduledTask.
`TASK_STATUS_COMPLETED`	A constant which can be used with the task_status property of a ScheduledTask.
`TASK_STATUS_PAUSED`	A constant which can be used with the task_status property of a ScheduledTask.
`TASK_STATUS_READY`	A constant which can be used with the task_status property of a ScheduledTask.
`TASK_TYPE_ACCELERATION`	A constant which can be used with the task_type property of a ScheduledTask.
`TASK_TYPE_PURGE`	A constant which can be used with the task_type property of a ScheduledTask.
`TASK_TYPE_SAVED_SEARCH`	A constant which can be used with the task_type property of a ScheduledTask.
`action`	[Required] Gets the action of this ScheduledTask.
`compartment_id`	[Required] Gets the compartment_id of this ScheduledTask.
`defined_tags`	Gets the defined_tags of this ScheduledTask.
`display_name`	[Required] Gets the display_name of this ScheduledTask.
`freeform_tags`	Gets the freeform_tags of this ScheduledTask.
`id`	[Required] Gets the id of this ScheduledTask.
`kind`	[Required] Gets the kind of this ScheduledTask.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ScheduledTask.
`num_occurrences`	Gets the num_occurrences of this ScheduledTask.
`pause_reason`	Gets the pause_reason of this ScheduledTask.
`schedules`	[Required] Gets the schedules of this ScheduledTask.
`task_status`	Gets the task_status of this ScheduledTask.
`task_type`	[Required] Gets the task_type of this ScheduledTask.
`time_created`	[Required] Gets the time_created of this ScheduledTask.
`time_of_next_execution`	Gets the time_of_next_execution of this ScheduledTask.
`time_updated`	[Required] Gets the time_updated of this ScheduledTask.
`work_request_id`	Gets the work_request_id of this ScheduledTask.

Methods

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

KIND_ACCELERATION = 'ACCELERATION'¶: A constant which can be used with the kind property of a ScheduledTask. This constant has a value of “ACCELERATION”

KIND_STANDARD = 'STANDARD'¶: A constant which can be used with the kind property of a ScheduledTask. This constant has a value of “STANDARD”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ScheduledTask. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ScheduledTask. This constant has a value of “DELETED”

PAUSE_REASON_METRIC_EXTRACTION_NOT_VALID = 'METRIC_EXTRACTION_NOT_VALID'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “METRIC_EXTRACTION_NOT_VALID”

PAUSE_REASON_PURGE_RESOURCE_NOT_FOUND = 'PURGE_RESOURCE_NOT_FOUND'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “PURGE_RESOURCE_NOT_FOUND”

PAUSE_REASON_QUERY_STRING_NOT_VALID = 'QUERY_STRING_NOT_VALID'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “QUERY_STRING_NOT_VALID”

PAUSE_REASON_SAVED_SEARCH_NOT_FOUND = 'SAVED_SEARCH_NOT_FOUND'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “SAVED_SEARCH_NOT_FOUND”

PAUSE_REASON_SAVED_SEARCH_NOT_VALID = 'SAVED_SEARCH_NOT_VALID'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “SAVED_SEARCH_NOT_VALID”

PAUSE_REASON_TENANCY_LIFECYCLE = 'TENANCY_LIFECYCLE'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “TENANCY_LIFECYCLE”

PAUSE_REASON_USER_ACTION = 'USER_ACTION'¶: A constant which can be used with the pause_reason property of a ScheduledTask. This constant has a value of “USER_ACTION”

TASK_STATUS_BLOCKED = 'BLOCKED'¶: A constant which can be used with the task_status property of a ScheduledTask. This constant has a value of “BLOCKED”

TASK_STATUS_COMPLETED = 'COMPLETED'¶: A constant which can be used with the task_status property of a ScheduledTask. This constant has a value of “COMPLETED”

TASK_STATUS_PAUSED = 'PAUSED'¶: A constant which can be used with the task_status property of a ScheduledTask. This constant has a value of “PAUSED”

TASK_STATUS_READY = 'READY'¶: A constant which can be used with the task_status property of a ScheduledTask. This constant has a value of “READY”

TASK_TYPE_ACCELERATION = 'ACCELERATION'¶: A constant which can be used with the task_type property of a ScheduledTask. This constant has a value of “ACCELERATION”

TASK_TYPE_PURGE = 'PURGE'¶: A constant which can be used with the task_type property of a ScheduledTask. This constant has a value of “PURGE”

TASK_TYPE_SAVED_SEARCH = 'SAVED_SEARCH'¶: A constant which can be used with the task_type property of a ScheduledTask. This constant has a value of “SAVED_SEARCH”

__init__(**kwargs)¶

Initializes a new ScheduledTask 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:

StandardTask

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

kind (str) – The value to assign to the kind property of this ScheduledTask. Allowed values for this property are: “ACCELERATION”, “STANDARD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
id (str) – The value to assign to the id property of this ScheduledTask.
display_name (str) – The value to assign to the display_name property of this ScheduledTask.
task_type (str) – The value to assign to the task_type property of this ScheduledTask. Allowed values for this property are: “SAVED_SEARCH”, “ACCELERATION”, “PURGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
schedules (list[oci.log_analytics.models.Schedule]) – The value to assign to the schedules property of this ScheduledTask.
action (oci.log_analytics.models.Action) – The value to assign to the action property of this ScheduledTask.
task_status (str) – The value to assign to the task_status property of this ScheduledTask. Allowed values for this property are: “READY”, “PAUSED”, “COMPLETED”, “BLOCKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
pause_reason (str) – The value to assign to the pause_reason property of this ScheduledTask. Allowed values for this property are: “METRIC_EXTRACTION_NOT_VALID”, “SAVED_SEARCH_NOT_VALID”, “SAVED_SEARCH_NOT_FOUND”, “QUERY_STRING_NOT_VALID”, “USER_ACTION”, “TENANCY_LIFECYCLE”, “PURGE_RESOURCE_NOT_FOUND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
work_request_id (str) – The value to assign to the work_request_id property of this ScheduledTask.
num_occurrences (int) – The value to assign to the num_occurrences property of this ScheduledTask.
compartment_id (str) – The value to assign to the compartment_id property of this ScheduledTask.
time_created (datetime) – The value to assign to the time_created property of this ScheduledTask.
time_updated (datetime) – The value to assign to the time_updated property of this ScheduledTask.
time_of_next_execution (datetime) – The value to assign to the time_of_next_execution property of this ScheduledTask.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduledTask. Allowed values for this property are: “ACTIVE”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ScheduledTask.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ScheduledTask.

action¶

[Required] Gets the action of this ScheduledTask.

Returns:	The action of this ScheduledTask.
Return type:	oci.log_analytics.models.Action

compartment_id¶

[Required] Gets the compartment_id of this ScheduledTask. Compartment Identifier OCID].

Returns:	The compartment_id of this ScheduledTask.
Return type:	str

defined_tags¶

Gets the defined_tags of this ScheduledTask. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ScheduledTask.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ScheduledTask. A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.

Returns:	The display_name of this ScheduledTask.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ScheduledTask. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ScheduledTask.
Return type:	dict(str, 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.

id¶

[Required] Gets the id of this ScheduledTask. The OCID of the data plane resource.

Returns:	The id of this ScheduledTask.
Return type:	str

kind¶

[Required] Gets the kind of this ScheduledTask. Discriminator.

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

Returns:	The kind of this ScheduledTask.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ScheduledTask. The current state of the scheduled task.

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

Returns:	The lifecycle_state of this ScheduledTask.
Return type:	str

num_occurrences¶

Gets the num_occurrences of this ScheduledTask. Number of execution occurrences.

Returns:	The num_occurrences of this ScheduledTask.
Return type:	int

pause_reason¶

Gets the pause_reason of this ScheduledTask. reason for taskStatus PAUSED.

Allowed values for this property are: “METRIC_EXTRACTION_NOT_VALID”, “SAVED_SEARCH_NOT_VALID”, “SAVED_SEARCH_NOT_FOUND”, “QUERY_STRING_NOT_VALID”, “USER_ACTION”, “TENANCY_LIFECYCLE”, “PURGE_RESOURCE_NOT_FOUND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The pause_reason of this ScheduledTask.
Return type:	str

schedules¶

[Required] Gets the schedules of this ScheduledTask. Schedules.

Returns:	The schedules of this ScheduledTask.
Return type:	list[oci.log_analytics.models.Schedule]

task_status¶

Gets the task_status of this ScheduledTask. Status of the scheduled task.

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

Returns:	The task_status of this ScheduledTask.
Return type:	str

task_type¶

[Required] Gets the task_type of this ScheduledTask. Task type.

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

Returns:	The task_type of this ScheduledTask.
Return type:	str

time_created¶

[Required] Gets the time_created of this ScheduledTask. The date and time the scheduled task was created, in the format defined by RFC3339.

Returns:	The time_created of this ScheduledTask.
Return type:	datetime

time_of_next_execution¶

Gets the time_of_next_execution of this ScheduledTask. The date and time the scheduled task will execute next, in the format defined by RFC3339.

Returns:	The time_of_next_execution of this ScheduledTask.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ScheduledTask. The date and time the scheduled task was last updated, in the format defined by RFC3339.

Returns:	The time_updated of this ScheduledTask.
Return type:	datetime

work_request_id¶

Gets the work_request_id of this ScheduledTask. most recent Work Request Identifier OCID] for the asynchronous request.

Returns:	The work_request_id of this ScheduledTask.
Return type:	str