CreateJobDetails¶
- class oci.database_management.models.CreateJobDetails(**kwargs)¶
Bases:
objectThe details required to create a job.
Attributes:
A constant which can be used with the database_sub_type property of a CreateJobDetails.
A constant which can be used with the database_sub_type property of a CreateJobDetails.
A constant which can be used with the database_sub_type property of a CreateJobDetails.
A constant which can be used with the database_sub_type property of a CreateJobDetails.
A constant which can be used with the database_sub_type property of a CreateJobDetails.
A constant which can be used with the job_type property of a CreateJobDetails.
[Required] Gets the compartment_id of this CreateJobDetails.
Gets the database_sub_type of this CreateJobDetails.
Gets the description of this CreateJobDetails.
[Required] Gets the job_type of this CreateJobDetails.
Gets the managed_database_group_id of this CreateJobDetails.
Gets the managed_database_id of this CreateJobDetails.
[Required] Gets the name of this CreateJobDetails.
Gets the result_location of this CreateJobDetails.
Gets the schedule_details of this CreateJobDetails.
[Required] Gets the schedule_type of this CreateJobDetails.
Gets the timeout of this CreateJobDetails.
Methods:
__init__(**kwargs)Initializes a new CreateJobDetails 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 CreateJobDetails. 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 CreateJobDetails. 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 CreateJobDetails. 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 CreateJobDetails. 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 CreateJobDetails. This constant has a value of “PDB”
- JOB_TYPE_SQL = 'SQL'¶
A constant which can be used with the job_type property of a CreateJobDetails. This constant has a value of “SQL”
- __init__(**kwargs)¶
Initializes a new CreateJobDetails 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
name (str) – The value to assign to the name property of this CreateJobDetails.
description (str) – The value to assign to the description property of this CreateJobDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateJobDetails.
managed_database_group_id (str) – The value to assign to the managed_database_group_id property of this CreateJobDetails.
managed_database_id (str) – The value to assign to the managed_database_id property of this CreateJobDetails.
database_sub_type (str) – The value to assign to the database_sub_type property of this CreateJobDetails. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”
schedule_type (str) – The value to assign to the schedule_type property of this CreateJobDetails.
job_type (str) – The value to assign to the job_type property of this CreateJobDetails. Allowed values for this property are: “SQL”
timeout (str) – The value to assign to the timeout property of this CreateJobDetails.
result_location (oci.database_management.models.JobExecutionResultLocation) – The value to assign to the result_location property of this CreateJobDetails.
schedule_details (oci.database_management.models.JobScheduleDetails) – The value to assign to the schedule_details property of this CreateJobDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateJobDetails. The OCID of the compartment in which the job resides.
- Returns
The compartment_id of this CreateJobDetails.
- Return type
str
- property database_sub_type¶
Gets the database_sub_type of this CreateJobDetails. The subtype of the Oracle Database where the job has to be executed. Only applicable when managedDatabaseGroupId is provided.
Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”, “ACD”, “ADB”
- Returns
The database_sub_type of this CreateJobDetails.
- Return type
str
- property description¶
Gets the description of this CreateJobDetails. The description of the job.
- Returns
The description of this CreateJobDetails.
- 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 job_type¶
[Required] Gets the job_type of this CreateJobDetails. The type of job.
Allowed values for this property are: “SQL”
- Returns
The job_type of this CreateJobDetails.
- Return type
str
- property managed_database_group_id¶
Gets the managed_database_group_id of this CreateJobDetails. The OCID of the Managed Database Group where the job has to be executed.
- Returns
The managed_database_group_id of this CreateJobDetails.
- Return type
str
- property managed_database_id¶
Gets the managed_database_id of this CreateJobDetails. The OCID of the Managed Database where the job has to be executed.
- Returns
The managed_database_id of this CreateJobDetails.
- Return type
str
- property name¶
[Required] Gets the name of this CreateJobDetails. The name of the job. Valid characters are uppercase or lowercase letters, numbers, and “_”. The name of the job cannot be modified. It must be unique in the compartment and must begin with an alphabetic character.
- Returns
The name of this CreateJobDetails.
- Return type
str
- property result_location¶
Gets the result_location of this CreateJobDetails.
- Returns
The result_location of this CreateJobDetails.
- Return type
- property schedule_details¶
Gets the schedule_details of this CreateJobDetails.
- Returns
The schedule_details of this CreateJobDetails.
- Return type
- property schedule_type¶
[Required] Gets the schedule_type of this CreateJobDetails. The schedule type of the job.
- Returns
The schedule_type of this CreateJobDetails.
- Return type
str
- property timeout¶
Gets the timeout of this CreateJobDetails. The job timeout duration, which is expressed like “1h 10m 15s”.
- Returns
The timeout of this CreateJobDetails.
- Return type
str