MediaWorkflowJob¶

class oci.media_services.models.MediaWorkflowJob(**kwargs)¶

Bases: object

A MediaWorkflowJob represents a run of a MediaWorkflow for a specific set of parameters and configurations.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_REJECTED`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`LIFECYCLE_STATE_WAITING`	A constant which can be used with the lifecycle_state property of a MediaWorkflowJob.
`compartment_id`	[Required] Gets the compartment_id of this MediaWorkflowJob.
`defined_tags`	Gets the defined_tags of this MediaWorkflowJob.
`display_name`	Gets the display_name of this MediaWorkflowJob.
`freeform_tags`	Gets the freeform_tags of this MediaWorkflowJob.
`id`	[Required] Gets the id of this MediaWorkflowJob.
`lifecycle_details`	Gets the lifecycle_details of this MediaWorkflowJob.
`lifecycle_state`	Gets the lifecycle_state of this MediaWorkflowJob.
`locks`	Gets the locks of this MediaWorkflowJob.
`media_workflow_configuration_ids`	Gets the media_workflow_configuration_ids of this MediaWorkflowJob.
`media_workflow_id`	[Required] Gets the media_workflow_id of this MediaWorkflowJob.
`outputs`	Gets the outputs of this MediaWorkflowJob.
`parameters`	Gets the parameters of this MediaWorkflowJob.
`runnable`	Gets the runnable of this MediaWorkflowJob.
`system_tags`	Gets the system_tags of this MediaWorkflowJob.
`task_lifecycle_state`	Gets the task_lifecycle_state of this MediaWorkflowJob.
`time_created`	Gets the time_created of this MediaWorkflowJob.
`time_ended`	Gets the time_ended of this MediaWorkflowJob.
`time_started`	Gets the time_started of this MediaWorkflowJob.
`time_updated`	Gets the time_updated of this MediaWorkflowJob.

Methods

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

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_REJECTED = 'REJECTED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “REJECTED”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_WAITING = 'WAITING'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflowJob. This constant has a value of “WAITING”

__init__(**kwargs)¶

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

Parameters:

media_workflow_configuration_ids (list[str]) – The value to assign to the media_workflow_configuration_ids property of this MediaWorkflowJob.
media_workflow_id (str) – The value to assign to the media_workflow_id property of this MediaWorkflowJob.
id (str) – The value to assign to the id property of this MediaWorkflowJob.
compartment_id (str) – The value to assign to the compartment_id property of this MediaWorkflowJob.
display_name (str) – The value to assign to the display_name property of this MediaWorkflowJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MediaWorkflowJob. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “REJECTED”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this MediaWorkflowJob.
task_lifecycle_state (list[oci.media_services.models.MediaWorkflowTaskState]) – The value to assign to the task_lifecycle_state property of this MediaWorkflowJob.
parameters (dict(str, object)) – The value to assign to the parameters property of this MediaWorkflowJob.
time_created (datetime) – The value to assign to the time_created property of this MediaWorkflowJob.
time_updated (datetime) – The value to assign to the time_updated property of this MediaWorkflowJob.
runnable (dict(str, object)) – The value to assign to the runnable property of this MediaWorkflowJob.
outputs (list[oci.media_services.models.JobOutput]) – The value to assign to the outputs property of this MediaWorkflowJob.
time_started (datetime) – The value to assign to the time_started property of this MediaWorkflowJob.
time_ended (datetime) – The value to assign to the time_ended property of this MediaWorkflowJob.
locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this MediaWorkflowJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MediaWorkflowJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MediaWorkflowJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MediaWorkflowJob.

compartment_id¶

[Required] Gets the compartment_id of this MediaWorkflowJob. Compartment Identifier.

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

defined_tags¶

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

display_name¶

Gets the display_name of this MediaWorkflowJob. Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this MediaWorkflowJob. Unique identifier for this run of the workflow.

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

lifecycle_details¶

Gets the lifecycle_details of this MediaWorkflowJob. The lifecyle details.

Returns:	The lifecycle_details of this MediaWorkflowJob.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this MediaWorkflowJob. The current state of the MediaWorkflowJob.

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

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

locks¶

Gets the locks of this MediaWorkflowJob. Locks associated with this resource.

Returns:	The locks of this MediaWorkflowJob.
Return type:	list[oci.media_services.models.ResourceLock]

media_workflow_configuration_ids¶

Gets the media_workflow_configuration_ids of this MediaWorkflowJob. Configurations to be applied to this run of the workflow.

Returns:	The media_workflow_configuration_ids of this MediaWorkflowJob.
Return type:	list[str]

media_workflow_id¶

[Required] Gets the media_workflow_id of this MediaWorkflowJob. The workflow to execute.

Returns:	The media_workflow_id of this MediaWorkflowJob.
Return type:	str

outputs¶

Gets the outputs of this MediaWorkflowJob. A list of JobOutput for the workflowJob.

Returns:	The outputs of this MediaWorkflowJob.
Return type:	list[oci.media_services.models.JobOutput]

parameters¶

Gets the parameters of this MediaWorkflowJob. Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow’s MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task’s key and the 2nd level keys refer to a parameter’s name.

Returns:	The parameters of this MediaWorkflowJob.
Return type:	dict(str, object)

runnable¶

Gets the runnable of this MediaWorkflowJob. A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved.

Returns:	The runnable of this MediaWorkflowJob.
Return type:	dict(str, object)

system_tags¶

Gets the system_tags of this MediaWorkflowJob. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

task_lifecycle_state¶

Gets the task_lifecycle_state of this MediaWorkflowJob. Status of each task.

Returns:	The task_lifecycle_state of this MediaWorkflowJob.
Return type:	list[oci.media_services.models.MediaWorkflowTaskState]

time_created¶

Gets the time_created of this MediaWorkflowJob. Creation time of the job. An RFC3339 formatted datetime string.

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

time_ended¶

Gets the time_ended of this MediaWorkflowJob. Time when the job finished. An RFC3339 formatted datetime string.

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

time_started¶

Gets the time_started of this MediaWorkflowJob. Time when the job started to execute. An RFC3339 formatted datetime string.

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

time_updated¶

Gets the time_updated of this MediaWorkflowJob. Updated time of the job. An RFC3339 formatted datetime string.

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