Execution¶

class oci.fleet_apps_management.models.Execution(**kwargs)¶

Bases: object

Task Execution associated with the Job.

Attributes

`STATUS_ABORTED`	A constant which can be used with the status property of a Execution.
`STATUS_ACCEPTED`	A constant which can be used with the status property of a Execution.
`STATUS_CANCELED`	A constant which can be used with the status property of a Execution.
`STATUS_FAILED`	A constant which can be used with the status property of a Execution.
`STATUS_IGNORED`	A constant which can be used with the status property of a Execution.
`STATUS_IN_PROGRESS`	A constant which can be used with the status property of a Execution.
`STATUS_NOT_APPLICABLE`	A constant which can be used with the status property of a Execution.
`STATUS_PAUSED`	A constant which can be used with the status property of a Execution.
`STATUS_SKIPPED`	A constant which can be used with the status property of a Execution.
`STATUS_SUCCEEDED`	A constant which can be used with the status property of a Execution.
`STATUS_TIMED_OUT`	A constant which can be used with the status property of a Execution.
`STATUS_WAITING`	A constant which can be used with the status property of a Execution.
`description`	Gets the description of this Execution.
`id`	[Required] Gets the id of this Execution.
`is_retry_exceeded`	Gets the is_retry_exceeded of this Execution.
`is_rollback_task`	Gets the is_rollback_task of this Execution.
`outcome`	Gets the outcome of this Execution.
`process_reference_id`	Gets the process_reference_id of this Execution.
`resource_id`	Gets the resource_id of this Execution.
`sequence`	Gets the sequence of this Execution.
`status`	[Required] Gets the status of this Execution.
`step_name`	Gets the step_name of this Execution.
`subjects`	Gets the subjects of this Execution.
`system_tags`	Gets the system_tags of this Execution.
`target_id`	Gets the target_id of this Execution.
`task_record_id`	Gets the task_record_id of this Execution.
`time_ended`	Gets the time_ended of this Execution.
`time_started`	Gets the time_started of this Execution.

Methods

__init__(**kwargs) Initializes a new Execution object with values from keyword arguments.

STATUS_ABORTED = 'ABORTED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “ABORTED”

STATUS_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “ACCEPTED”

STATUS_CANCELED = 'CANCELED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “CANCELED”

STATUS_FAILED = 'FAILED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “FAILED”

STATUS_IGNORED = 'IGNORED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “IGNORED”

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a Execution. This constant has a value of “IN_PROGRESS”

STATUS_NOT_APPLICABLE = 'NOT_APPLICABLE'¶: A constant which can be used with the status property of a Execution. This constant has a value of “NOT_APPLICABLE”

STATUS_PAUSED = 'PAUSED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “PAUSED”

STATUS_SKIPPED = 'SKIPPED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “SKIPPED”

STATUS_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the status property of a Execution. This constant has a value of “SUCCEEDED”

STATUS_TIMED_OUT = 'TIMED_OUT'¶: A constant which can be used with the status property of a Execution. This constant has a value of “TIMED_OUT”

STATUS_WAITING = 'WAITING'¶: A constant which can be used with the status property of a Execution. This constant has a value of “WAITING”

__init__(**kwargs)¶

Initializes a new Execution 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 Execution.
task_record_id (str) – The value to assign to the task_record_id property of this Execution.
step_name (str) – The value to assign to the step_name property of this Execution.
process_reference_id (str) – The value to assign to the process_reference_id property of this Execution.
sequence (str) – The value to assign to the sequence property of this Execution.
subjects (list[str]) – The value to assign to the subjects property of this Execution.
status (str) – The value to assign to the status property of this Execution. Allowed values for this property are: “ACCEPTED”, “WAITING”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SKIPPED”, “IGNORED”, “NOT_APPLICABLE”, “ABORTED”, “TIMED_OUT”, “PAUSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
outcome (oci.fleet_apps_management.models.Outcome) – The value to assign to the outcome property of this Execution.
target_id (str) – The value to assign to the target_id property of this Execution.
time_started (datetime) – The value to assign to the time_started property of this Execution.
time_ended (datetime) – The value to assign to the time_ended property of this Execution.
is_rollback_task (bool) – The value to assign to the is_rollback_task property of this Execution.
description (str) – The value to assign to the description property of this Execution.
resource_id (str) – The value to assign to the resource_id property of this Execution.
is_retry_exceeded (bool) – The value to assign to the is_retry_exceeded property of this Execution.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Execution.

description¶

Gets the description of this Execution. Description of the Execution status. If there are any errors, this can also include a short error message.

Returns:	The description of this Execution.
Return type:	str

id¶

[Required] Gets the id of this Execution. Unique Id associated with the task execution.

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

is_retry_exceeded¶

Gets the is_retry_exceeded of this Execution. An attribute which tells if further retries are allowed for the task on failure.

Returns:	The is_retry_exceeded of this Execution.
Return type:	bool

is_rollback_task¶

Gets the is_rollback_task of this Execution. Is this a rollback task?

Returns:	The is_rollback_task of this Execution.
Return type:	bool

outcome¶

Gets the outcome of this Execution.

Returns:	The outcome of this Execution.
Return type:	oci.fleet_apps_management.models.Outcome

process_reference_id¶

Gets the process_reference_id of this Execution. Unique process-reference identifier returned by the execution client. In some cases, this can be a runcommand OCID.

Returns:	The process_reference_id of this Execution.
Return type:	str

resource_id¶

Gets the resource_id of this Execution. Resource Identifier associated with the Work Request.

Returns:	The resource_id of this Execution.
Return type:	str

sequence¶

Gets the sequence of this Execution. The sequence of the task.

Returns:	The sequence of this Execution.
Return type:	str

status¶

[Required] Gets the status of this Execution. Status of the Task

Allowed values for this property are: “ACCEPTED”, “WAITING”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELED”, “SKIPPED”, “IGNORED”, “NOT_APPLICABLE”, “ABORTED”, “TIMED_OUT”, “PAUSED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this Execution.
Return type:	str

step_name¶

Gets the step_name of this Execution. Name of the step.

Returns:	The step_name of this Execution.
Return type:	str

subjects¶

Gets the subjects of this Execution. Subjects that are tied to the task.

Returns:	The subjects of this Execution.
Return type:	list[str]

system_tags¶

Gets the system_tags of this Execution. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this Execution.
Return type:	dict(str, dict(str, object))

target_id¶

Gets the target_id of this Execution. Target associated with the execution.

Returns:	The target_id of this Execution.
Return type:	str

task_record_id¶

Gets the task_record_id of this Execution. The OCID of taskRecord.

Returns:	The task_record_id of this Execution.
Return type:	str

time_ended¶

Gets the time_ended of this Execution. The time the task ended. An RFC3339 formatted datetime string.

Returns:	The time_ended of this Execution.
Return type:	datetime

time_started¶

Gets the time_started of this Execution. The time the task started. An RFC3339 formatted datetime string.

Returns:	The time_started of this Execution.
Return type:	datetime