Class MediaWorkflowTask
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.
Inherited Members
Namespace: Oci.MediaservicesService.Models
Assembly: OCI.DotNetSDK.Mediaservices.dll
Syntax
public class MediaWorkflowTask
Properties
EnableParameterReference
Declaration
[JsonProperty(PropertyName = "enableParameterReference")]
public string EnableParameterReference { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
EnableWhenReferencedParameterEquals
Declaration
[JsonProperty(PropertyName = "enableWhenReferencedParameterEquals")]
public Dictionary<string, object> EnableWhenReferencedParameterEquals { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, object> | 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. |
Key
Declaration
[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type | Description |
---|---|
string | 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. |
Remarks
Required
Parameters
Declaration
[Required(ErrorMessage = "Parameters is required.")]
[JsonProperty(PropertyName = "parameters")]
public Dictionary<string, object> Parameters { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, object> | 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. |
Remarks
Required
Prerequisites
Declaration
[JsonProperty(PropertyName = "prerequisites")]
public List<string> Prerequisites { get; set; }
Property Value
Type | Description |
---|---|
List<string> | Keys to the other tasks in this workflow that must be completed before execution of this task can begin. |
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
public string Type { get; set; }
Property Value
Type | Description |
---|---|
string | The type of process to run at this task. Refers to the name of a MediaWorkflowTaskDeclaration. |
Remarks
Required
Version
Declaration
[Required(ErrorMessage = "Version is required.")]
[JsonProperty(PropertyName = "version")]
public long? Version { get; set; }
Property Value
Type | Description |
---|---|
long? | The version of the MediaWorkflowTaskDeclaration. |
Remarks
Required