MediaWorkflowTaskDeclaration¶

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

Bases: object

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

Methods

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

Attributes

`locks`	Gets the locks of this MediaWorkflowTaskDeclaration.
`name`	[Required] Gets the name of this MediaWorkflowTaskDeclaration.
`parameters_schema`	[Required] Gets the parameters_schema of this MediaWorkflowTaskDeclaration.
`parameters_schema_allowing_references`	[Required] Gets the parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration.
`version`	[Required] Gets the version of this MediaWorkflowTaskDeclaration.

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this MediaWorkflowTaskDeclaration.
version (int) – The value to assign to the version property of this MediaWorkflowTaskDeclaration.
parameters_schema (dict(str, object)) – The value to assign to the parameters_schema property of this MediaWorkflowTaskDeclaration.
parameters_schema_allowing_references (dict(str, object)) – The value to assign to the parameters_schema_allowing_references property of this MediaWorkflowTaskDeclaration.
locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this MediaWorkflowTaskDeclaration.

locks¶

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

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

name¶

[Required] Gets the name of this MediaWorkflowTaskDeclaration. MediaWorkflowTaskDeclaration identifier. The name and version should be unique among MediaWorkflowTaskDeclarations.

Returns:	The name of this MediaWorkflowTaskDeclaration.
Return type:	str

parameters_schema¶

[Required] Gets the parameters_schema of this MediaWorkflowTaskDeclaration. JSON schema specifying the parameters supported by this type of task. This is used to validate tasks’ parameters when jobs are created.

Returns:	The parameters_schema of this MediaWorkflowTaskDeclaration.
Return type:	dict(str, object)

parameters_schema_allowing_references¶

[Required] Gets the parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration. 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.

Returns:	The parameters_schema_allowing_references of this MediaWorkflowTaskDeclaration.
Return type:	dict(str, object)

version¶

[Required] Gets the version of this MediaWorkflowTaskDeclaration. 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.

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