CreateMediaWorkflowJobByNameDetails

class oci.media_services.models.CreateMediaWorkflowJobByNameDetails(**kwargs)

Bases: CreateMediaWorkflowJobDetails

Information to run a system MediaWorkflow identified by its name.

Attributes:

WORKFLOW_IDENTIFIER_TYPE_ID

A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails.

WORKFLOW_IDENTIFIER_TYPE_NAME

A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails.

compartment_id

[Required] Gets the compartment_id of this CreateMediaWorkflowJobDetails.

defined_tags

Gets the defined_tags of this CreateMediaWorkflowJobDetails.

display_name

Gets the display_name of this CreateMediaWorkflowJobDetails.

freeform_tags

Gets the freeform_tags of this CreateMediaWorkflowJobDetails.

locks

Gets the locks of this CreateMediaWorkflowJobDetails.

media_workflow_configuration_ids

Gets the media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails.

media_workflow_name

Gets the media_workflow_name of this CreateMediaWorkflowJobByNameDetails.

parameters

Gets the parameters of this CreateMediaWorkflowJobDetails.

workflow_identifier_type

[Required] Gets the workflow_identifier_type of this CreateMediaWorkflowJobDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateMediaWorkflowJobByNameDetails object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

WORKFLOW_IDENTIFIER_TYPE_ID = 'ID'

A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails. This constant has a value of “ID”

WORKFLOW_IDENTIFIER_TYPE_NAME = 'NAME'

A constant which can be used with the workflow_identifier_type property of a CreateMediaWorkflowJobDetails. This constant has a value of “NAME”

__init__(**kwargs)

Initializes a new CreateMediaWorkflowJobByNameDetails object with values from keyword arguments. The default value of the workflow_identifier_type attribute of this class is NAME and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • workflow_identifier_type (str) – The value to assign to the workflow_identifier_type property of this CreateMediaWorkflowJobByNameDetails. Allowed values for this property are: “ID”, “NAME”

  • media_workflow_configuration_ids (list[str]) – The value to assign to the media_workflow_configuration_ids property of this CreateMediaWorkflowJobByNameDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateMediaWorkflowJobByNameDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateMediaWorkflowJobByNameDetails.

  • parameters (dict(str, object)) – The value to assign to the parameters property of this CreateMediaWorkflowJobByNameDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMediaWorkflowJobByNameDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMediaWorkflowJobByNameDetails.

  • locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this CreateMediaWorkflowJobByNameDetails.

  • media_workflow_name (str) – The value to assign to the media_workflow_name property of this CreateMediaWorkflowJobByNameDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateMediaWorkflowJobDetails. ID of the compartment in which the job should be created.

Returns

The compartment_id of this CreateMediaWorkflowJobDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateMediaWorkflowJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this CreateMediaWorkflowJobDetails.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this CreateMediaWorkflowJobDetails. Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information.

Returns

The display_name of this CreateMediaWorkflowJobDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateMediaWorkflowJobDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this CreateMediaWorkflowJobDetails.

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property locks

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

Returns

The locks of this CreateMediaWorkflowJobDetails.

Return type

list[oci.media_services.models.ResourceLock]

property media_workflow_configuration_ids

Gets the media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails. Configurations to be applied to this run of the workflow.

Returns

The media_workflow_configuration_ids of this CreateMediaWorkflowJobDetails.

Return type

list[str]

property media_workflow_name

Gets the media_workflow_name of this CreateMediaWorkflowJobByNameDetails. Name of the system MediaWorkflow that should be run.

Returns

The media_workflow_name of this CreateMediaWorkflowJobByNameDetails.

Return type

str

property parameters

Gets the parameters of this CreateMediaWorkflowJobDetails. Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow’s MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task’s key and the 2nd level keys refer to a parameter’s name.

Returns

The parameters of this CreateMediaWorkflowJobDetails.

Return type

dict(str, object)

property workflow_identifier_type

[Required] Gets the workflow_identifier_type of this CreateMediaWorkflowJobDetails. Discriminate identification of a workflow by name versus a workflow by ID.

Allowed values for this property are: “ID”, “NAME”

Returns

The workflow_identifier_type of this CreateMediaWorkflowJobDetails.

Return type

str