Class VideoJob

Job details for a video analysis.

Inheritance

object

VideoJob

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AivisionService.Models

Assembly: OCI.DotNetSDK.Aivision.dll

Syntax

public class VideoJob

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ocid of the compartment that starts the job.

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. For Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

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

Property Value

Type	Description
string	Video job display name.

Features

Declaration

[Required(ErrorMessage = "Features is required.")]
[JsonProperty(PropertyName = "features")]
public List<VideoFeature> Features { get; set; }

Property Value

Type	Description
List<VideoFeature>	a list of document analysis features.

Remarks

Required

FreeformTags

Declaration

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

Property Value

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

Id

Declaration

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

Property Value

Type	Description
string	Id of the job.

Remarks

Required

InputLocation

Declaration

[JsonProperty(PropertyName = "inputLocation")]
public InputLocation InputLocation { get; set; }

Property Value

Type	Description
InputLocation

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VideoJob.LifecycleDetailsEnum? LifecycleDetails { get; set; }

Property Value

Type	Description
VideoJob.LifecycleDetailsEnum?	Detailed status of FAILED state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VideoJob.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
VideoJob.LifecycleStateEnum?	The current state of the batch document job.

Remarks

Required

OutputLocation

Declaration

[Required(ErrorMessage = "OutputLocation is required.")]
[JsonProperty(PropertyName = "outputLocation")]
public OutputLocation OutputLocation { get; set; }

Property Value

Type	Description
OutputLocation

Remarks

Required

PercentComplete

Declaration

[JsonProperty(PropertyName = "percentComplete")]
public float? PercentComplete { get; set; }

Property Value

Type	Description
float?	How much progress the operation has made, vs the total amount of work that must be performed.

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. For Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeAccepted

Declaration

[Required(ErrorMessage = "TimeAccepted is required.")]
[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }

Property Value

Type	Description
DateTime?	Job accepted time.

Remarks

Required

TimeFinished

Declaration

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

Property Value

Type	Description
DateTime?	Job finished time.

TimeStarted

Declaration

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

Property Value

Type	Description
DateTime?	Job started time.