Class MediaWorkflowTaskDeclaration

The declaration of a type of task that can be used in a MediaWorkflow.

Inheritance

object

MediaWorkflowTaskDeclaration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MediaservicesService.Models

Assembly: OCI.DotNetSDK.Mediaservices.dll

Syntax

public class MediaWorkflowTaskDeclaration

Properties

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	MediaWorkflowTaskDeclaration identifier. The name and version should be unique among MediaWorkflowTaskDeclarations.

Remarks

Required

ParametersSchema

Declaration

[Required(ErrorMessage = "ParametersSchema is required.")]
[JsonProperty(PropertyName = "parametersSchema")]
public Dictionary<string, object> ParametersSchema { get; set; }

Property Value

Type	Description
Dictionary<string, object>	JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' parameters when jobs are created.

Remarks

Required

ParametersSchemaAllowingReferences

Declaration

[Required(ErrorMessage = "ParametersSchemaAllowingReferences is required.")]
[JsonProperty(PropertyName = "parametersSchemaAllowingReferences")]
public Dictionary<string, object> ParametersSchemaAllowingReferences { get; set; }

Property Value

Type	Description
Dictionary<string, object>	JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the ${/path/to/another/parmeter} syntax. This is used to validate task parameters when workflows are created.

Remarks

Required

Version

Declaration

[Required(ErrorMessage = "Version is required.")]
[JsonProperty(PropertyName = "version")]
public int? Version { get; set; }

Property Value

Type	Description
int?	The version of MediaWorkflowTaskDeclaration, incremented whenever the team implementing the task processor modifies the JSON schema of this declaration's definitions, parameters or list of required parameters.

Remarks

Required