MediaWorkflow¶

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

Bases: object

Configurable workflows that define the series of tasks that will be used to process video files.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a MediaWorkflow.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a MediaWorkflow.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a MediaWorkflow.
`compartment_id`	[Required] Gets the compartment_id of this MediaWorkflow.
`defined_tags`	Gets the defined_tags of this MediaWorkflow.
`display_name`	[Required] Gets the display_name of this MediaWorkflow.
`freeform_tags`	Gets the freeform_tags of this MediaWorkflow.
`id`	[Required] Gets the id of this MediaWorkflow.
`lifecycle_state`	Gets the lifecycle_state of this MediaWorkflow.
`lifecyle_details`	Gets the lifecyle_details of this MediaWorkflow.
`locks`	Gets the locks of this MediaWorkflow.
`media_workflow_configuration_ids`	Gets the media_workflow_configuration_ids of this MediaWorkflow.
`parameters`	Gets the parameters of this MediaWorkflow.
`system_tags`	Gets the system_tags of this MediaWorkflow.
`tasks`	[Required] Gets the tasks of this MediaWorkflow.
`time_created`	Gets the time_created of this MediaWorkflow.
`time_updated`	Gets the time_updated of this MediaWorkflow.
`version`	Gets the version of this MediaWorkflow.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflow. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflow. This constant has a value of “DELETED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a MediaWorkflow. This constant has a value of “NEEDS_ATTENTION”

__init__(**kwargs)¶

Initializes a new MediaWorkflow 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 MediaWorkflow.
display_name (str) – The value to assign to the display_name property of this MediaWorkflow.
compartment_id (str) – The value to assign to the compartment_id property of this MediaWorkflow.
tasks (list[oci.media_services.models.MediaWorkflowTask]) – The value to assign to the tasks property of this MediaWorkflow.
media_workflow_configuration_ids (list[str]) – The value to assign to the media_workflow_configuration_ids property of this MediaWorkflow.
parameters (dict(str, object)) – The value to assign to the parameters property of this MediaWorkflow.
time_created (datetime) – The value to assign to the time_created property of this MediaWorkflow.
time_updated (datetime) – The value to assign to the time_updated property of this MediaWorkflow.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MediaWorkflow. Allowed values for this property are: “ACTIVE”, “NEEDS_ATTENTION”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecyle_details (str) – The value to assign to the lifecyle_details property of this MediaWorkflow.
version (int) – The value to assign to the version property of this MediaWorkflow.
locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this MediaWorkflow.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this MediaWorkflow.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this MediaWorkflow.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this MediaWorkflow.

compartment_id¶

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

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

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this MediaWorkflow. Name of the Media Workflow. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this MediaWorkflow. Unique identifier that is immutable on creation.

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

lifecycle_state¶

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

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

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

lifecyle_details¶

Gets the lifecyle_details of this MediaWorkflow. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecyle_details of this MediaWorkflow.
Return type:	str

locks¶

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

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

media_workflow_configuration_ids¶

Gets the media_workflow_configuration_ids of this MediaWorkflow. Configurations to be applied to all the runs of this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that appear in the configuration at the highest index will be used.

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

parameters¶

Gets the parameters of this MediaWorkflow. JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow.

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

system_tags¶

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

tasks¶

[Required] Gets the tasks of this MediaWorkflow. The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.

Returns:	The tasks of this MediaWorkflow.
Return type:	list[oci.media_services.models.MediaWorkflowTask]

time_created¶

Gets the time_created of this MediaWorkflow. The time when the MediaWorkflow was created. An RFC3339 formatted datetime string.

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

time_updated¶

Gets the time_updated of this MediaWorkflow. The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string.

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

version¶

Gets the version of this MediaWorkflow. The version of the MediaWorkflow.

Returns:	The version of this MediaWorkflow.
Return type:	int