MediaWorkflowTask¶

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

Bases: object

Defines the type of processing to be run at a given point in the workflow, parameters to configure the processing, and any processing that must be completed before this processing begins.

Methods

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

Attributes

`enable_parameter_reference`	Gets the enable_parameter_reference of this MediaWorkflowTask.
`enable_when_referenced_parameter_equals`	Gets the enable_when_referenced_parameter_equals of this MediaWorkflowTask.
`key`	[Required] Gets the key of this MediaWorkflowTask.
`parameters`	[Required] Gets the parameters of this MediaWorkflowTask.
`prerequisites`	Gets the prerequisites of this MediaWorkflowTask.
`type`	[Required] Gets the type of this MediaWorkflowTask.
`version`	[Required] Gets the version of this MediaWorkflowTask.

__init__(**kwargs)¶

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

Parameters:

type (str) – The value to assign to the type property of this MediaWorkflowTask.
version (int) – The value to assign to the version property of this MediaWorkflowTask.
key (str) – The value to assign to the key property of this MediaWorkflowTask.
prerequisites (list[str]) – The value to assign to the prerequisites property of this MediaWorkflowTask.
enable_parameter_reference (str) – The value to assign to the enable_parameter_reference property of this MediaWorkflowTask.
enable_when_referenced_parameter_equals (dict(str, object)) – The value to assign to the enable_when_referenced_parameter_equals property of this MediaWorkflowTask.
parameters (dict(str, object)) – The value to assign to the parameters property of this MediaWorkflowTask.

enable_parameter_reference¶

Gets the enable_parameter_reference of this MediaWorkflowTask. Allows this task to be conditionally enabled. If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task’s workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.

Returns:	The enable_parameter_reference of this MediaWorkflowTask.
Return type:	str

enable_when_referenced_parameter_equals¶

Gets the enable_when_referenced_parameter_equals of this MediaWorkflowTask. Used in conjunction with enableParameterReference to conditionally enable a task. When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.

Returns:	The enable_when_referenced_parameter_equals of this MediaWorkflowTask.
Return type:	dict(str, object)

key¶

[Required] Gets the key of this MediaWorkflowTask. A unique identifier for this task within its workflow. Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.

Returns:	The key of this MediaWorkflowTask.
Return type:	str

parameters¶

[Required] Gets the parameters of this MediaWorkflowTask. Data specifiying how this task is to be run. The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.

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

prerequisites¶

Gets the prerequisites of this MediaWorkflowTask. Keys to the other tasks in this workflow that must be completed before execution of this task can begin.

Returns:	The prerequisites of this MediaWorkflowTask.
Return type:	list[str]

type¶

[Required] Gets the type of this MediaWorkflowTask. The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration.

Returns:	The type of this MediaWorkflowTask.
Return type:	str

version¶

[Required] Gets the version of this MediaWorkflowTask. The version of the MediaWorkflowTaskDeclaration.

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