Class TranscriptionJobSummary
Summary of the Transcription Job.
Inherited Members
Namespace: Oci.AispeechService.Models
Assembly: OCI.DotNetSDK.Aispeech.dll
Syntax
public class TranscriptionJobSummary
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 where you want to create the job. |
Remarks
Required
CreatedBy
Declaration
[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the user who created the job. |
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-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly display name for the job. |
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 | The OCID of the job. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { 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. |
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public TranscriptionJob.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
TranscriptionJob.LifecycleStateEnum? | The current state of the Speech Job. |
OutstandingTasks
Declaration
[JsonProperty(PropertyName = "outstandingTasks")]
public int? OutstandingTasks { get; set; }
Property Value
Type | Description |
---|---|
int? | Total outstanding tasks in a job. |
PercentComplete
Declaration
[JsonProperty(PropertyName = "percentComplete")]
public int? PercentComplete { get; set; }
Property Value
Type | Description |
---|---|
int? | How much progress the operation has made, vs the total amount of work that must be performed. |
SuccessfulTasks
Declaration
[JsonProperty(PropertyName = "successfulTasks")]
public int? SuccessfulTasks { get; set; }
Property Value
Type | Description |
---|---|
int? | Total successful tasks in a job. |
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"}}. |
TimeAccepted
Declaration
[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Job accepted time. |
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. |
TotalTasks
Declaration
[JsonProperty(PropertyName = "totalTasks")]
public int? TotalTasks { get; set; }
Property Value
Type | Description |
---|---|
int? | Total number of tasks in a job. |