StandardTask¶

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

Bases: oci.log_analytics.models.scheduled_task.ScheduledTask

Log analytics scheduled task resource.

Attributes

`KIND_ACCELERATION`	str(object=’’) -> str
`KIND_STANDARD`	str(object=’’) -> str
`LAST_EXECUTION_STATUS_FAILED`	A constant which can be used with the last_execution_status property of a StandardTask.
`LAST_EXECUTION_STATUS_SUCCEEDED`	A constant which can be used with the last_execution_status property of a StandardTask.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`PAUSE_REASON_METRIC_EXTRACTION_NOT_VALID`	str(object=’’) -> str
`PAUSE_REASON_PURGE_RESOURCE_NOT_FOUND`	str(object=’’) -> str
`PAUSE_REASON_QUERY_STRING_NOT_VALID`	str(object=’’) -> str
`PAUSE_REASON_SAVED_SEARCH_NOT_FOUND`	str(object=’’) -> str
`PAUSE_REASON_SAVED_SEARCH_NOT_VALID`	str(object=’’) -> str
`PAUSE_REASON_TENANCY_LIFECYCLE`	str(object=’’) -> str
`PAUSE_REASON_USER_ACTION`	str(object=’’) -> str
`TASK_STATUS_BLOCKED`	str(object=’’) -> str
`TASK_STATUS_COMPLETED`	str(object=’’) -> str
`TASK_STATUS_PAUSED`	str(object=’’) -> str
`TASK_STATUS_READY`	str(object=’’) -> str
`TASK_TYPE_ACCELERATION`	str(object=’’) -> str
`TASK_TYPE_PURGE`	str(object=’’) -> str
`TASK_TYPE_SAVED_SEARCH`	str(object=’’) -> str
`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.
`last_execution_status`	Gets the last_execution_status of this StandardTask.
`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_last_executed`	Gets the time_last_executed of this StandardTask.
`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 StandardTask 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'¶

KIND_STANDARD = 'STANDARD'¶

LAST_EXECUTION_STATUS_FAILED = 'FAILED'¶: A constant which can be used with the last_execution_status property of a StandardTask. This constant has a value of “FAILED”

LAST_EXECUTION_STATUS_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the last_execution_status property of a StandardTask. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

PAUSE_REASON_METRIC_EXTRACTION_NOT_VALID = 'METRIC_EXTRACTION_NOT_VALID'¶

PAUSE_REASON_PURGE_RESOURCE_NOT_FOUND = 'PURGE_RESOURCE_NOT_FOUND'¶

PAUSE_REASON_QUERY_STRING_NOT_VALID = 'QUERY_STRING_NOT_VALID'¶

PAUSE_REASON_SAVED_SEARCH_NOT_FOUND = 'SAVED_SEARCH_NOT_FOUND'¶

PAUSE_REASON_SAVED_SEARCH_NOT_VALID = 'SAVED_SEARCH_NOT_VALID'¶

PAUSE_REASON_TENANCY_LIFECYCLE = 'TENANCY_LIFECYCLE'¶

PAUSE_REASON_USER_ACTION = 'USER_ACTION'¶

TASK_STATUS_BLOCKED = 'BLOCKED'¶

TASK_STATUS_COMPLETED = 'COMPLETED'¶

TASK_STATUS_PAUSED = 'PAUSED'¶

TASK_STATUS_READY = 'READY'¶

TASK_TYPE_ACCELERATION = 'ACCELERATION'¶

TASK_TYPE_PURGE = 'PURGE'¶

TASK_TYPE_SAVED_SEARCH = 'SAVED_SEARCH'¶

__init__(**kwargs)¶

Initializes a new StandardTask object with values from keyword arguments. The default value of the kind attribute of this class is STANDARD and it should not be changed. 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 StandardTask. 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 StandardTask.
display_name (str) – The value to assign to the display_name property of this StandardTask.
task_type (str) – The value to assign to the task_type property of this StandardTask. 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 StandardTask.
action (oci.log_analytics.models.Action) – The value to assign to the action property of this StandardTask.
task_status (str) – The value to assign to the task_status property of this StandardTask. 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 StandardTask. 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 StandardTask.
num_occurrences (int) – The value to assign to the num_occurrences property of this StandardTask.
compartment_id (str) – The value to assign to the compartment_id property of this StandardTask.
time_created (datetime) – The value to assign to the time_created property of this StandardTask.
time_updated (datetime) – The value to assign to the time_updated property of this StandardTask.
time_of_next_execution (datetime) – The value to assign to the time_of_next_execution property of this StandardTask.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this StandardTask. 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 StandardTask.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this StandardTask.
last_execution_status (str) – The value to assign to the last_execution_status property of this StandardTask. Allowed values for this property are: “FAILED”, “SUCCEEDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_last_executed (datetime) – The value to assign to the time_last_executed property of this StandardTask.

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

last_execution_status¶

Gets the last_execution_status of this StandardTask. The most recent task execution status.

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

Returns:	The last_execution_status of this StandardTask.
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_last_executed¶

Gets the time_last_executed of this StandardTask. The date and time the scheduled task last executed, in the format defined by RFC3339.

Returns:	The time_last_executed of this StandardTask.
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