JobSummary¶
- class oci.ai_language.models.JobSummary(**kwargs)¶
Bases:
objectsub set of Job details data which need returns in list API
Methods:
__init__(**kwargs)Initializes a new JobSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this JobSummary.
Gets the completed_documents of this JobSummary.
Gets the created_by of this JobSummary.
Gets the description of this JobSummary.
[Required] Gets the display_name of this JobSummary.
Gets the failed_documents of this JobSummary.
[Required] Gets the id of this JobSummary.
Gets the lifecycle_details of this JobSummary.
Gets the lifecycle_state of this JobSummary.
Gets the pending_documents of this JobSummary.
Gets the percent_complete of this JobSummary.
Gets the time_accepted of this JobSummary.
Gets the time_completed of this JobSummary.
Gets the time_started of this JobSummary.
Gets the total_documents of this JobSummary.
Gets the warnings_count of this JobSummary.
- __init__(**kwargs)¶
Initializes a new JobSummary 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 JobSummary.
display_name (str) – The value to assign to the display_name property of this JobSummary.
description (str) – The value to assign to the description property of this JobSummary.
compartment_id (str) – The value to assign to the compartment_id property of this JobSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this JobSummary.
percent_complete (int) – The value to assign to the percent_complete property of this JobSummary.
total_documents (int) – The value to assign to the total_documents property of this JobSummary.
pending_documents (int) – The value to assign to the pending_documents property of this JobSummary.
completed_documents (int) – The value to assign to the completed_documents property of this JobSummary.
failed_documents (int) – The value to assign to the failed_documents property of this JobSummary.
warnings_count (int) – The value to assign to the warnings_count property of this JobSummary.
created_by (str) – The value to assign to the created_by property of this JobSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this JobSummary.
time_started (datetime) – The value to assign to the time_started property of this JobSummary.
time_completed (datetime) – The value to assign to the time_completed property of this JobSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this JobSummary. The OCID of the compartment where you want to create the job.
- Returns
The compartment_id of this JobSummary.
- Return type
str
- property completed_documents¶
Gets the completed_documents of this JobSummary. Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
- Returns
The completed_documents of this JobSummary.
- Return type
int
- property created_by¶
Gets the created_by of this JobSummary. The OCID of the user who created the job.
- Returns
The created_by of this JobSummary.
- Return type
str
- property description¶
Gets the description of this JobSummary. A short description of the job.
- Returns
The description of this JobSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this JobSummary. A user-friendly display name for the job.
- Returns
The display_name of this JobSummary.
- Return type
str
- property failed_documents¶
Gets the failed_documents of this JobSummary. Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
- Returns
The failed_documents of this JobSummary.
- Return type
int
- property id¶
[Required] Gets the id of this JobSummary. The OCID of the job.
- Returns
The id of this JobSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this JobSummary. 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 JobSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this JobSummary. The current state of the Speech Job.
- Returns
The lifecycle_state of this JobSummary.
- Return type
str
- property pending_documents¶
Gets the pending_documents of this JobSummary. Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.
- Returns
The pending_documents of this JobSummary.
- Return type
int
- property percent_complete¶
Gets the percent_complete of this JobSummary. How much progress the operation has made, vs the total amount of work that must be performed.
- Returns
The percent_complete of this JobSummary.
- Return type
int
- property time_accepted¶
Gets the time_accepted of this JobSummary. Job accepted time.
- Returns
The time_accepted of this JobSummary.
- Return type
datetime
- property time_completed¶
Gets the time_completed of this JobSummary. Job finished time.
- Returns
The time_completed of this JobSummary.
- Return type
datetime
- property time_started¶
Gets the time_started of this JobSummary. Job started time.
- Returns
The time_started of this JobSummary.
- Return type
datetime
- property total_documents¶
Gets the total_documents of this JobSummary. Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.
- Returns
The total_documents of this JobSummary.
- Return type
int
- property warnings_count¶
Gets the warnings_count of this JobSummary. warnings count
- Returns
The warnings_count of this JobSummary.
- Return type
int