Show / Hide Table of Contents

Class StreamJob

Job details for a stream analysis.

Inheritance
object
StreamJob
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 StreamJob

Properties

AgentParticipantId

Declaration
[JsonProperty(PropertyName = "agentParticipantId")]
public string AgentParticipantId { get; set; }
Property Value
Type Description
string

participant id of agent where results need to be sent

CompartmentId

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

OCID of compartment

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

Stream job display name.

Features

Declaration
[Required(ErrorMessage = "Features is required.")]
[JsonProperty(PropertyName = "features")]
public List<VideoStreamFeature> Features { get; set; }
Property Value
Type Description
List<VideoStreamFeature>

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

OCID of the streamJob.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

Additional details about current state of streamJob

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public StreamJob.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
StreamJob.LifecycleStateEnum?

The current state of the Stream job.

Remarks

Required

StreamOutputLocation

Declaration
[JsonProperty(PropertyName = "streamOutputLocation")]
public StreamOutputLocation StreamOutputLocation { get; set; }
Property Value
Type Description
StreamOutputLocation

StreamSourceId

Declaration
[Required(ErrorMessage = "StreamSourceId is required.")]
[JsonProperty(PropertyName = "streamSourceId")]
public string StreamSourceId { get; set; }
Property Value
Type Description
string

OCID of the streamSource

Remarks

Required

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

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

When the streamJob was created, as an RFC3339 datetime string.

Remarks

Required

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

When the stream job was updated, as an RFC3339 datetime string.

In this article
Back to top