Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TranscriptionJob

Description of Transcription Job.

Properties

Optional additionalTranscriptionFormats

additionalTranscriptionFormats: Array<AdditionalTranscriptionFormats>

Transcription format. JSON format will always be provided in addition to any formats in this list.

compartmentId

compartmentId: string

The OCID of the compartment where you want to create the job.

Optional createdBy

createdBy: undefined | string

The OCID of the user who created the job.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"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"}}}.

Optional description

description: undefined | string

A short description of the job.

Optional displayName

displayName: undefined | string

A user-friendly display name for the job.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}.

id

id: string

The OCID of the job.

inputLocation

Optional lifecycleDetails

lifecycleDetails: undefined | 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.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the Job.

modelDetails

Optional normalization

normalization: model.TranscriptionNormalization

outputLocation

outputLocation: OutputLocation

Optional outstandingTasks

outstandingTasks: undefined | number

Total outstanding tasks in a job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional percentComplete

percentComplete: undefined | number

How much progress the operation has made, vs the total amount of work that must be performed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional successfulTasks

successfulTasks: undefined | number

Total successful tasks in a job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}.

Optional timeAccepted

timeAccepted: Date

Job accepted time.

Optional timeFinished

timeFinished: Date

Job finished time.

Optional timeStarted

timeStarted: Date

Job started time.

Optional totalTasks

totalTasks: undefined | number

Total tasks in a job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional ttlInDays

ttlInDays: undefined | number

Time to live duration in days for Job. Job will be available till max 90 days. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj