TranscriptionJobSummary¶

class oci.ai_speech.models.TranscriptionJobSummary(**kwargs)¶

Bases: object

Summary of the Transcription Job.

Methods

__init__(**kwargs) Initializes a new TranscriptionJobSummary object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this TranscriptionJobSummary.
`created_by`	Gets the created_by of this TranscriptionJobSummary.
`defined_tags`	Gets the defined_tags of this TranscriptionJobSummary.
`display_name`	[Required] Gets the display_name of this TranscriptionJobSummary.
`freeform_tags`	Gets the freeform_tags of this TranscriptionJobSummary.
`id`	[Required] Gets the id of this TranscriptionJobSummary.
`lifecycle_details`	Gets the lifecycle_details of this TranscriptionJobSummary.
`lifecycle_state`	Gets the lifecycle_state of this TranscriptionJobSummary.
`outstanding_tasks`	Gets the outstanding_tasks of this TranscriptionJobSummary.
`percent_complete`	Gets the percent_complete of this TranscriptionJobSummary.
`successful_tasks`	Gets the successful_tasks of this TranscriptionJobSummary.
`system_tags`	Gets the system_tags of this TranscriptionJobSummary.
`time_accepted`	Gets the time_accepted of this TranscriptionJobSummary.
`time_finished`	Gets the time_finished of this TranscriptionJobSummary.
`time_started`	Gets the time_started of this TranscriptionJobSummary.
`total_tasks`	Gets the total_tasks of this TranscriptionJobSummary.

__init__(**kwargs)¶

Initializes a new TranscriptionJobSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this TranscriptionJobSummary.
display_name (str) – The value to assign to the display_name property of this TranscriptionJobSummary.
compartment_id (str) – The value to assign to the compartment_id property of this TranscriptionJobSummary.
created_by (str) – The value to assign to the created_by property of this TranscriptionJobSummary.
percent_complete (int) – The value to assign to the percent_complete property of this TranscriptionJobSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this TranscriptionJobSummary.
time_started (datetime) – The value to assign to the time_started property of this TranscriptionJobSummary.
time_finished (datetime) – The value to assign to the time_finished property of this TranscriptionJobSummary.
total_tasks (int) – The value to assign to the total_tasks property of this TranscriptionJobSummary.
outstanding_tasks (int) – The value to assign to the outstanding_tasks property of this TranscriptionJobSummary.
successful_tasks (int) – The value to assign to the successful_tasks property of this TranscriptionJobSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TranscriptionJobSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this TranscriptionJobSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TranscriptionJobSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TranscriptionJobSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this TranscriptionJobSummary.

compartment_id¶

[Required] Gets the compartment_id of this TranscriptionJobSummary. The OCID of the compartment where you want to create the job.

Returns:	The compartment_id of this TranscriptionJobSummary.
Return type:	str

created_by¶

Gets the created_by of this TranscriptionJobSummary. The OCID of the user who created the job.

Returns:	The created_by of this TranscriptionJobSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this TranscriptionJobSummary. 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”}}.

Returns:	The defined_tags of this TranscriptionJobSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this TranscriptionJobSummary. A user-friendly display name for the job.

Returns:	The display_name of this TranscriptionJobSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this TranscriptionJobSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

Returns:	The freeform_tags of this TranscriptionJobSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this TranscriptionJobSummary. The OCID of the job.

Returns:	The id of this TranscriptionJobSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this TranscriptionJobSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:	The lifecycle_details of this TranscriptionJobSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this TranscriptionJobSummary. The current state of the Speech Job.

Returns:	The lifecycle_state of this TranscriptionJobSummary.
Return type:	str

outstanding_tasks¶

Gets the outstanding_tasks of this TranscriptionJobSummary. Total outstanding tasks in a job.

Returns:	The outstanding_tasks of this TranscriptionJobSummary.
Return type:	int

percent_complete¶

Gets the percent_complete of this TranscriptionJobSummary. How much progress the operation has made, vs the total amount of work that must be performed.

Returns:	The percent_complete of this TranscriptionJobSummary.
Return type:	int

successful_tasks¶

Gets the successful_tasks of this TranscriptionJobSummary. Total successful tasks in a job.

Returns:	The successful_tasks of this TranscriptionJobSummary.
Return type:	int

system_tags¶

Gets the system_tags of this TranscriptionJobSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

Returns:	The system_tags of this TranscriptionJobSummary.
Return type:	dict(str, dict(str, object))

time_accepted¶

Gets the time_accepted of this TranscriptionJobSummary. Job accepted time.

Returns:	The time_accepted of this TranscriptionJobSummary.
Return type:	datetime

time_finished¶

Gets the time_finished of this TranscriptionJobSummary. Job finished time.

Returns:	The time_finished of this TranscriptionJobSummary.
Return type:	datetime

time_started¶

Gets the time_started of this TranscriptionJobSummary. Job started time.

Returns:	The time_started of this TranscriptionJobSummary.
Return type:	datetime

total_tasks¶

Gets the total_tasks of this TranscriptionJobSummary. Total number of tasks in a job.

Returns:	The total_tasks of this TranscriptionJobSummary.
Return type:	int