Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MediaWorkflowTaskDeclaration

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

Properties

Functions

Properties

Optional locks

locks: Array<ResourceLock>

Locks associated with this resource.

name

name: string

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

parametersSchema

parametersSchema: object

JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' parameters when jobs are created.

Type declaration

  • [key: string]: any

parametersSchemaAllowingReferences

parametersSchemaAllowingReferences: 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.

Type declaration

  • [key: string]: any

version

version: number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj