Class MediaWorkflowJob

A MediaWorkflowJob represents a run of a MediaWorkflow for a specific set of parameters and configurations.

Inheritance

object

MediaWorkflowJob

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MediaservicesService.Models

Assembly: OCI.DotNetSDK.Mediaservices.dll

Syntax

public class MediaWorkflowJob

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	Compartment Identifier.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	Unique identifier for this run of the workflow.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	The lifecyle details.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MediaWorkflowJob.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
MediaWorkflowJob.LifecycleStateEnum?	The current state of the MediaWorkflowJob.

Locks

Declaration

[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }

Property Value

Type	Description
List<ResourceLock>	Locks associated with this resource.

MediaWorkflowConfigurationIds

Declaration

[JsonProperty(PropertyName = "mediaWorkflowConfigurationIds")]
public List<string> MediaWorkflowConfigurationIds { get; set; }

Property Value

Type	Description
List<string>	Configurations to be applied to this run of the workflow.

MediaWorkflowId

Declaration

[Required(ErrorMessage = "MediaWorkflowId is required.")]
[JsonProperty(PropertyName = "mediaWorkflowId")]
public string MediaWorkflowId { get; set; }

Property Value

Type	Description
string	The workflow to execute.

Remarks

Required

Outputs

Declaration

[JsonProperty(PropertyName = "outputs")]
public List<JobOutput> Outputs { get; set; }

Property Value

Type	Description
List<JobOutput>	A list of JobOutput for the workflowJob.

Parameters

Declaration

[JsonProperty(PropertyName = "parameters")]
public Dictionary<string, object> Parameters { get; set; }

Property Value

Type

Description

Dictionary<string, object>

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.

Runnable

Declaration

[JsonProperty(PropertyName = "runnable")]
public Dictionary<string, object> Runnable { get; set; }

Property Value

Type	Description
Dictionary<string, object>	A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved.

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TaskLifecycleState

Declaration

[JsonProperty(PropertyName = "taskLifecycleState")]
public List<MediaWorkflowTaskState> TaskLifecycleState { get; set; }

Property Value

Type	Description
List<MediaWorkflowTaskState>	Status of each task.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Creation time of the job. An RFC3339 formatted datetime string.

TimeEnded

Declaration

[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }

Property Value

Type	Description
DateTime?	Time when the job finished. An RFC3339 formatted datetime string.

TimeStarted

Declaration

[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	Time when the job started to execute. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Updated time of the job. An RFC3339 formatted datetime string.