ScheduledTaskSummary

class oci.log_analytics.models.ScheduledTaskSummary(**kwargs)

Bases: object

Summary information about a scheduled task.

Attributes:

LAST_EXECUTION_STATUS_FAILED

A constant which can be used with the last_execution_status property of a ScheduledTaskSummary.

LAST_EXECUTION_STATUS_SUCCEEDED

A constant which can be used with the last_execution_status property of a ScheduledTaskSummary.

SCHEDULE_TYPE_CRON

A constant which can be used with the schedule_type property of a ScheduledTaskSummary.

SCHEDULE_TYPE_FIXED_FREQUENCY

A constant which can be used with the schedule_type property of a ScheduledTaskSummary.

TASK_STATUS_BLOCKED

A constant which can be used with the task_status property of a ScheduledTaskSummary.

TASK_STATUS_COMPLETED

A constant which can be used with the task_status property of a ScheduledTaskSummary.

TASK_STATUS_PAUSED

A constant which can be used with the task_status property of a ScheduledTaskSummary.

TASK_STATUS_READY

A constant which can be used with the task_status property of a ScheduledTaskSummary.

TASK_TYPE_ACCELERATION

A constant which can be used with the task_type property of a ScheduledTaskSummary.

TASK_TYPE_PURGE

A constant which can be used with the task_type property of a ScheduledTaskSummary.

TASK_TYPE_SAVED_SEARCH

A constant which can be used with the task_type property of a ScheduledTaskSummary.

compartment_id

[Required] Gets the compartment_id of this ScheduledTaskSummary.

defined_tags

Gets the defined_tags of this ScheduledTaskSummary.

display_name

[Required] Gets the display_name of this ScheduledTaskSummary.

freeform_tags

Gets the freeform_tags of this ScheduledTaskSummary.

id

[Required] Gets the id of this ScheduledTaskSummary.

last_execution_status

Gets the last_execution_status of this ScheduledTaskSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this ScheduledTaskSummary.

pause_reason

Gets the pause_reason of this ScheduledTaskSummary.

schedule_type

Gets the schedule_type of this ScheduledTaskSummary.

target_service

Gets the target_service of this ScheduledTaskSummary.

task_status

Gets the task_status of this ScheduledTaskSummary.

task_type

[Required] Gets the task_type of this ScheduledTaskSummary.

time_created

[Required] Gets the time_created of this ScheduledTaskSummary.

time_last_executed

Gets the time_last_executed of this ScheduledTaskSummary.

time_updated

[Required] Gets the time_updated of this ScheduledTaskSummary.

work_request_id

Gets the work_request_id of this ScheduledTaskSummary.

Methods:

__init__(**kwargs)

Initializes a new ScheduledTaskSummary object with values from keyword arguments.

LAST_EXECUTION_STATUS_FAILED = 'FAILED'

A constant which can be used with the last_execution_status property of a ScheduledTaskSummary. 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 ScheduledTaskSummary. This constant has a value of “SUCCEEDED”

SCHEDULE_TYPE_CRON = 'CRON'

A constant which can be used with the schedule_type property of a ScheduledTaskSummary. This constant has a value of “CRON”

SCHEDULE_TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'

A constant which can be used with the schedule_type property of a ScheduledTaskSummary. This constant has a value of “FIXED_FREQUENCY”

TASK_STATUS_BLOCKED = 'BLOCKED'

A constant which can be used with the task_status property of a ScheduledTaskSummary. This constant has a value of “BLOCKED”

TASK_STATUS_COMPLETED = 'COMPLETED'

A constant which can be used with the task_status property of a ScheduledTaskSummary. This constant has a value of “COMPLETED”

TASK_STATUS_PAUSED = 'PAUSED'

A constant which can be used with the task_status property of a ScheduledTaskSummary. This constant has a value of “PAUSED”

TASK_STATUS_READY = 'READY'

A constant which can be used with the task_status property of a ScheduledTaskSummary. This constant has a value of “READY”

TASK_TYPE_ACCELERATION = 'ACCELERATION'

A constant which can be used with the task_type property of a ScheduledTaskSummary. This constant has a value of “ACCELERATION”

TASK_TYPE_PURGE = 'PURGE'

A constant which can be used with the task_type property of a ScheduledTaskSummary. This constant has a value of “PURGE”

A constant which can be used with the task_type property of a ScheduledTaskSummary. This constant has a value of “SAVED_SEARCH”

__init__(**kwargs)

Initializes a new ScheduledTaskSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this ScheduledTaskSummary.

  • task_type (str) – The value to assign to the task_type property of this ScheduledTaskSummary. 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’.

  • target_service (str) – The value to assign to the target_service property of this ScheduledTaskSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this ScheduledTaskSummary.

  • time_created (datetime) – The value to assign to the time_created property of this ScheduledTaskSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this ScheduledTaskSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ScheduledTaskSummary.

  • task_status (str) – The value to assign to the task_status property of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

  • work_request_id (str) – The value to assign to the work_request_id property of this ScheduledTaskSummary.

  • display_name (str) – The value to assign to the display_name property of this ScheduledTaskSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ScheduledTaskSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ScheduledTaskSummary.

  • last_execution_status (str) – The value to assign to the last_execution_status property of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

  • schedule_type (str) – The value to assign to the schedule_type property of this ScheduledTaskSummary. Allowed values for this property are: “FIXED_FREQUENCY”, “CRON”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property compartment_id

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

Returns

The compartment_id of this ScheduledTaskSummary.

Return type

str

property defined_tags

Gets the defined_tags of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

dict(str, str)

property id

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

Returns

The id of this ScheduledTaskSummary.

Return type

str

property last_execution_status

Gets the last_execution_status of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

str

property lifecycle_state

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

Returns

The lifecycle_state of this ScheduledTaskSummary.

Return type

str

property pause_reason

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

Returns

The pause_reason of this ScheduledTaskSummary.

Return type

str

property schedule_type

Gets the schedule_type of this ScheduledTaskSummary. Type of the task schedule

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

Returns

The schedule_type of this ScheduledTaskSummary.

Return type

str

property target_service

Gets the target_service of this ScheduledTaskSummary. Target Service

Returns

The target_service of this ScheduledTaskSummary.

Return type

str

property task_status

Gets the task_status of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

str

property task_type

[Required] Gets the task_type of this ScheduledTaskSummary. 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 ScheduledTaskSummary.

Return type

str

property time_created

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

Returns

The time_created of this ScheduledTaskSummary.

Return type

datetime

property time_last_executed

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

Returns

The time_last_executed of this ScheduledTaskSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this ScheduledTaskSummary.

Return type

datetime

property work_request_id

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

Returns

The work_request_id of this ScheduledTaskSummary.

Return type

str