Job¶
- class oci.database_management.models.Job(**kwargs)¶
Bases:
objectThe details of the job.
Attributes:
A constant which can be used with the database_sub_type property of a Job.
A constant which can be used with the database_sub_type property of a Job.
A constant which can be used with the database_sub_type property of a Job.
A constant which can be used with the database_sub_type property of a Job.
A constant which can be used with the database_sub_type property of a Job.
A constant which can be used with the job_type property of a Job.
A constant which can be used with the lifecycle_state property of a Job.
A constant which can be used with the lifecycle_state property of a Job.
A constant which can be used with the schedule_type property of a Job.
A constant which can be used with the schedule_type property of a Job.
[Required] Gets the compartment_id of this Job.
Gets the database_sub_type of this Job.
Gets the description of this Job.
[Required] Gets the id of this Job.
[Required] Gets the job_type of this Job.
[Required] Gets the lifecycle_state of this Job.
Gets the managed_database_group_id of this Job.
Gets the managed_database_id of this Job.
Gets the managed_databases_details of this Job.
[Required] Gets the name of this Job.
Gets the result_location of this Job.
Gets the schedule_details of this Job.
[Required] Gets the schedule_type of this Job.
Gets the submission_error_message of this Job.
[Required] Gets the time_created of this Job.
[Required] Gets the time_updated of this Job.
Gets the timeout of this Job.
Methods:
__init__(**kwargs)Initializes a new Job object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- DATABASE_SUB_TYPE_ACD = 'ACD'¶
A constant which can be used with the database_sub_type property of a Job. This constant has a value of “ACD”
- DATABASE_SUB_TYPE_ADB = 'ADB'¶
A constant which can be used with the database_sub_type property of a Job. This constant has a value of “ADB”
- DATABASE_SUB_TYPE_CDB = 'CDB'¶
A constant which can be used with the database_sub_type property of a Job. This constant has a value of “CDB”
- DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'¶
A constant which can be used with the database_sub_type property of a Job. This constant has a value of “NON_CDB”
- DATABASE_SUB_TYPE_PDB = 'PDB'¶
A constant which can be used with the database_sub_type property of a Job. This constant has a value of “PDB”
- JOB_TYPE_SQL = 'SQL'¶
A constant which can be used with the job_type property of a Job. This constant has a value of “SQL”
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Job. This constant has a value of “INACTIVE”
- SCHEDULE_TYPE_IMMEDIATE = 'IMMEDIATE'¶
A constant which can be used with the schedule_type property of a Job. This constant has a value of “IMMEDIATE”
- SCHEDULE_TYPE_LATER = 'LATER'¶
A constant which can be used with the schedule_type property of a Job. This constant has a value of “LATER”
- __init__(**kwargs)¶
Initializes a new Job object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 Job.
compartment_id (str) – The value to assign to the compartment_id property of this Job.
name (str) – The value to assign to the name property of this Job.
description (str) – The value to assign to the description property of this Job.
managed_database_group_id (str) – The value to assign to the managed_database_group_id property of this Job.
managed_database_id (str) – The value to assign to the managed_database_id property of this Job.
managed_databases_details (list[oci.database_management.models.JobDatabase]) – The value to assign to the managed_databases_details property of this Job.
database_sub_type (str) – The value to assign to the database_sub_type property of this Job. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
schedule_type (str) – The value to assign to the schedule_type property of this Job. Allowed values for this property are: “IMMEDIATE”, “LATER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
job_type (str) – The value to assign to the job_type property of this Job. Allowed values for this property are: “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Job. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
timeout (str) – The value to assign to the timeout property of this Job.
result_location (oci.database_management.models.JobExecutionResultLocation) – The value to assign to the result_location property of this Job.
schedule_details (oci.database_management.models.JobScheduleDetails) – The value to assign to the schedule_details property of this Job.
submission_error_message (str) – The value to assign to the submission_error_message property of this Job.
time_created (datetime) – The value to assign to the time_created property of this Job.
time_updated (datetime) – The value to assign to the time_updated property of this Job.
- property compartment_id¶
[Required] Gets the compartment_id of this Job. The OCID of the compartment in which the job resides.
- Returns
The compartment_id of this Job.
- Return type
str
- property database_sub_type¶
Gets the database_sub_type of this Job. The subtype of the Oracle Database where the job has to be executed. Applicable only when managedDatabaseGroupId is provided.
Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The database_sub_type of this Job.
- Return type
str
- property description¶
Gets the description of this Job. The description of the job.
- Returns
The description of this Job.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property id¶
[Required] Gets the id of this Job. The OCID of the job.
- Returns
The id of this Job.
- Return type
str
- property job_type¶
[Required] Gets the job_type of this Job. The type of job.
Allowed values for this property are: “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The job_type of this Job.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this Job. The lifecycle state of the job.
Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Job.
- Return type
str
- property managed_database_group_id¶
Gets the managed_database_group_id of this Job. The OCID of the Managed Database Group where the job has to be executed.
- Returns
The managed_database_group_id of this Job.
- Return type
str
- property managed_database_id¶
Gets the managed_database_id of this Job. The OCID of the Managed Database where the job has to be executed.
- Returns
The managed_database_id of this Job.
- Return type
str
- property managed_databases_details¶
Gets the managed_databases_details of this Job. The details of the Managed Databases where the job has to be executed.
- Returns
The managed_databases_details of this Job.
- Return type
- property name¶
[Required] Gets the name of this Job. The display name of the job.
- Returns
The name of this Job.
- Return type
str
- property result_location¶
Gets the result_location of this Job.
- Returns
The result_location of this Job.
- Return type
- property schedule_details¶
Gets the schedule_details of this Job.
- Returns
The schedule_details of this Job.
- Return type
- property schedule_type¶
[Required] Gets the schedule_type of this Job. The schedule type of the job.
Allowed values for this property are: “IMMEDIATE”, “LATER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The schedule_type of this Job.
- Return type
str
- property submission_error_message¶
Gets the submission_error_message of this Job. The error message that is returned if the job submission fails. Null is returned in all other scenarios.
- Returns
The submission_error_message of this Job.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this Job. The date and time when the job was created.
- Returns
The time_created of this Job.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this Job. The date and time when the job was last updated.
- Returns
The time_updated of this Job.
- Return type
datetime
- property timeout¶
Gets the timeout of this Job. The job timeout duration, which is expressed like “1h 10m 15s”.
- Returns
The timeout of this Job.
- Return type
str