Class MediaWorkflow

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

Inheritance

object

MediaWorkflow

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 MediaWorkflow

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

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

Property Value

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

Remarks

Required

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 that is immutable on creation.

Remarks

Required

LifecycleState

Declaration

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

Property Value

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

LifecyleDetails

Declaration

[JsonProperty(PropertyName = "lifecyleDetails")]
public string LifecyleDetails { get; set; }

Property Value

Type	Description
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.

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

Parameters

Declaration

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

Property Value

Type	Description
Dictionary<string, 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.

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"}}

Tasks

Declaration

[Required(ErrorMessage = "Tasks is required.")]
[JsonProperty(PropertyName = "tasks")]
public List<MediaWorkflowTask> Tasks { get; set; }

Property Value

Type	Description
List<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.

Remarks

Required

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time when the MediaWorkflow was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

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

Property Value

Type	Description
DateTime?	The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string.

Version

Declaration

[JsonProperty(PropertyName = "version")]
public long? Version { get; set; }

Property Value

Type	Description
long?	The version of the MediaWorkflow.