CreateMediaWorkflowJobByIdDetails¶

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

Bases: oci.media_services.models.create_media_workflow_job_details.CreateMediaWorkflowJobDetails

Information to run a MediaWorkflow identified by its OCID.

Attributes

`WORKFLOW_IDENTIFIER_TYPE_ID`	str(object=’’) -> str
`WORKFLOW_IDENTIFIER_TYPE_NAME`	str(object=’’) -> str
`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_id`	Gets the media_workflow_id of this CreateMediaWorkflowJobByIdDetails.
`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 CreateMediaWorkflowJobByIdDetails 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'¶

WORKFLOW_IDENTIFIER_TYPE_NAME = 'NAME'¶

__init__(**kwargs)¶

Initializes a new CreateMediaWorkflowJobByIdDetails object with values from keyword arguments. The default value of the workflow_identifier_type attribute of this class is ID 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 CreateMediaWorkflowJobByIdDetails. 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 CreateMediaWorkflowJobByIdDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateMediaWorkflowJobByIdDetails.
display_name (str) – The value to assign to the display_name property of this CreateMediaWorkflowJobByIdDetails.
parameters (dict(str, object)) – The value to assign to the parameters property of this CreateMediaWorkflowJobByIdDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateMediaWorkflowJobByIdDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateMediaWorkflowJobByIdDetails.
locks (list[oci.media_services.models.ResourceLock]) – The value to assign to the locks property of this CreateMediaWorkflowJobByIdDetails.
media_workflow_id (str) – The value to assign to the media_workflow_id property of this CreateMediaWorkflowJobByIdDetails.

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

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))

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

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.

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]

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]

media_workflow_id¶

Gets the media_workflow_id of this CreateMediaWorkflowJobByIdDetails. OCID of the MediaWorkflow that should be run.

Returns:	The media_workflow_id of this CreateMediaWorkflowJobByIdDetails.
Return type:	str

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)

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