CreateSqlJobDetails

class oci.database_management.models.CreateSqlJobDetails(**kwargs)

Bases: oci.database_management.models.create_job_details.CreateJobDetails

The details specific to the SQL job request.

Attributes

DATABASE_SUB_TYPE_CDB str(object=’’) -> str
DATABASE_SUB_TYPE_NON_CDB str(object=’’) -> str
DATABASE_SUB_TYPE_PDB str(object=’’) -> str
JOB_TYPE_SQL str(object=’’) -> str
compartment_id [Required] Gets the compartment_id of this CreateJobDetails.
database_sub_type Gets the database_sub_type of this CreateJobDetails.
description Gets the description of this CreateJobDetails.
job_type [Required] Gets the job_type of this CreateJobDetails.
managed_database_group_id Gets the managed_database_group_id of this CreateJobDetails.
managed_database_id Gets the managed_database_id of this CreateJobDetails.
name [Required] Gets the name of this CreateJobDetails.
operation_type [Required] Gets the operation_type of this CreateSqlJobDetails.
password Gets the password of this CreateSqlJobDetails.
result_location Gets the result_location of this CreateJobDetails.
role Gets the role of this CreateSqlJobDetails.
schedule_type [Required] Gets the schedule_type of this CreateJobDetails.
sql_text Gets the sql_text of this CreateSqlJobDetails.
sql_type Gets the sql_type of this CreateSqlJobDetails.
timeout Gets the timeout of this CreateJobDetails.
user_name Gets the user_name of this CreateSqlJobDetails.

Methods

__init__(**kwargs) Initializes a new CreateSqlJobDetails 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_CDB = 'CDB'
DATABASE_SUB_TYPE_NON_CDB = 'NON_CDB'
DATABASE_SUB_TYPE_PDB = 'PDB'
JOB_TYPE_SQL = 'SQL'
__init__(**kwargs)

Initializes a new CreateSqlJobDetails object with values from keyword arguments. The default value of the job_type attribute of this class is SQL and it should not be changed. 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 CreateSqlJobDetails.
  • description (str) – The value to assign to the description property of this CreateSqlJobDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateSqlJobDetails.
  • managed_database_group_id (str) – The value to assign to the managed_database_group_id property of this CreateSqlJobDetails.
  • managed_database_id (str) – The value to assign to the managed_database_id property of this CreateSqlJobDetails.
  • database_sub_type (str) – The value to assign to the database_sub_type property of this CreateSqlJobDetails. Allowed values for this property are: “CDB”, “PDB”, “NON_CDB”
  • schedule_type (str) – The value to assign to the schedule_type property of this CreateSqlJobDetails.
  • job_type (str) – The value to assign to the job_type property of this CreateSqlJobDetails. Allowed values for this property are: “SQL”
  • timeout (str) – The value to assign to the timeout property of this CreateSqlJobDetails.
  • result_location (oci.database_management.models.JobExecutionResultLocation) – The value to assign to the result_location property of this CreateSqlJobDetails.
  • sql_text (str) – The value to assign to the sql_text property of this CreateSqlJobDetails.
  • sql_type (str) – The value to assign to the sql_type property of this CreateSqlJobDetails.
  • operation_type (str) – The value to assign to the operation_type property of this CreateSqlJobDetails.
  • user_name (str) – The value to assign to the user_name property of this CreateSqlJobDetails.
  • password (str) – The value to assign to the password property of this CreateSqlJobDetails.
  • role (str) – The value to assign to the role property of this CreateSqlJobDetails.
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
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”

Returns:The database_sub_type of this CreateJobDetails.
Return type:str
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.

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
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
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
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
operation_type

[Required] Gets the operation_type of this CreateSqlJobDetails. The SQL operation type.

Returns:The operation_type of this CreateSqlJobDetails.
Return type:str
password

Gets the password of this CreateSqlJobDetails. The password for the database user name used to execute the SQL job.

Returns:The password of this CreateSqlJobDetails.
Return type:str
result_location

Gets the result_location of this CreateJobDetails.

Returns:The result_location of this CreateJobDetails.
Return type:oci.database_management.models.JobExecutionResultLocation
role

Gets the role of this CreateSqlJobDetails. The role of the database user. Indicates whether the database user is a normal user or sysdba.

Returns:The role of this CreateSqlJobDetails.
Return type:str
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
sql_text

Gets the sql_text of this CreateSqlJobDetails. The SQL text to be executed as part of the job.

Returns:The sql_text of this CreateSqlJobDetails.
Return type:str
sql_type

Gets the sql_type of this CreateSqlJobDetails.

Returns:The sql_type of this CreateSqlJobDetails.
Return type:str
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
user_name

Gets the user_name of this CreateSqlJobDetails. The database user name used to execute the SQL job. If the job is being executed on a Managed Database Group, then the user name should exist on all the databases in the group with the same password.

Returns:The user_name of this CreateSqlJobDetails.
Return type:str