Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MediaWorkflow

Configurable workflows that define the series of tasks that will be used to process video files.

Enumerations

Properties

Functions

Properties

compartmentId

compartmentId: string

Compartment Identifier.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

Name of the Media Workflow. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

Unique identifier that is immutable on creation.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the MediaWorkflow.

Optional lifecyleDetails

lifecyleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Optional locks

locks: Array<ResourceLock>

Locks associated with this resource.

Optional mediaWorkflowConfigurationIds

mediaWorkflowConfigurationIds: Array<string>

Configurations to be applied to all the runs of this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that appear in the configuration at the highest index will be used.

Optional parameters

parameters: undefined | object

JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

tasks

tasks: Array<MediaWorkflowTask>

The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.

Optional timeCreated

timeCreated: Date

The time when the MediaWorkflow was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string.

Optional version

version: undefined | number

The version of the MediaWorkflow. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj