StepSummary¶

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

Bases: object

Task associated with the Job.

Attributes

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

Methods

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

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

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

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

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

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

STATUS_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the status property of a StepSummary. 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 StepSummary. This constant has a value of “NOT_APPLICABLE”

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

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

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

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

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

__init__(**kwargs)¶

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

Parameters:

task_record_id (str) – The value to assign to the task_record_id property of this StepSummary.
step_name (str) – The value to assign to the step_name property of this StepSummary.
sequence (str) – The value to assign to the sequence property of this StepSummary.
status (str) – The value to assign to the status property of this StepSummary. 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’.
time_started (datetime) – The value to assign to the time_started property of this StepSummary.
time_ended (datetime) – The value to assign to the time_ended property of this StepSummary.
is_rollback_task (bool) – The value to assign to the is_rollback_task property of this StepSummary.
description (str) – The value to assign to the description property of this StepSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this StepSummary.

description¶

Gets the description of this StepSummary. Description of the step Execution.

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

is_rollback_task¶

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

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

sequence¶

Gets the sequence of this StepSummary. The sequence of the step.

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

status¶

[Required] Gets the status of this StepSummary. 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 StepSummary.
Return type:	str

step_name¶

[Required] Gets the step_name of this StepSummary. Name of the Step.

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

system_tags¶

Gets the system_tags of this StepSummary. 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 StepSummary.
Return type:	dict(str, dict(str, object))

task_record_id¶

Gets the task_record_id of this StepSummary. The OCID of taskRecord assocaited with the step.

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

time_ended¶

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

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

time_started¶

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

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