CreateSqlJobDetails

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

Bases: CreateJobDetails

The details specific to the SQL job request.

Attributes:

DATABASE_SUB_TYPE_ACD

A constant which can be used with the database_sub_type property of a CreateJobDetails.

DATABASE_SUB_TYPE_ADB

A constant which can be used with the database_sub_type property of a CreateJobDetails.

DATABASE_SUB_TYPE_CDB

A constant which can be used with the database_sub_type property of a CreateJobDetails.

DATABASE_SUB_TYPE_NON_CDB

A constant which can be used with the database_sub_type property of a CreateJobDetails.

DATABASE_SUB_TYPE_PDB

A constant which can be used with the database_sub_type property of a CreateJobDetails.

JOB_TYPE_SQL

A constant which can be used with the job_type property of a CreateJobDetails.

compartment_id

[Required] Gets the compartment_id of this CreateJobDetails.

database_sub_type

Gets the database_sub_type of this CreateJobDetails.

defined_tags

Gets the defined_tags of this CreateSqlJobDetails.

description

Gets the description of this CreateJobDetails.

freeform_tags

Gets the freeform_tags of this CreateSqlJobDetails.

in_binds

Gets the in_binds of this CreateSqlJobDetails.

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.

named_credential_id

Gets the named_credential_id of this CreateSqlJobDetails.

operation_type

[Required] Gets the operation_type of this CreateSqlJobDetails.

out_binds

Gets the out_binds 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_details

Gets the schedule_details of this CreateJobDetails.

schedule_type

[Required] Gets the schedule_type of this CreateJobDetails.

secret_id

Gets the secret_id of this CreateSqlJobDetails.

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_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 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”, “ACD”, “ADB”

  • 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.

  • schedule_details (oci.database_management.models.JobScheduleDetails) – The value to assign to the schedule_details property of this CreateSqlJobDetails.

  • sql_text (str) – The value to assign to the sql_text property of this CreateSqlJobDetails.

  • in_binds (oci.database_management.models.JobInBindsDetails) – The value to assign to the in_binds property of this CreateSqlJobDetails.

  • out_binds (oci.database_management.models.JobOutBindsDetails) – The value to assign to the out_binds 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.

  • secret_id (str) – The value to assign to the secret_id property of this CreateSqlJobDetails.

  • named_credential_id (str) – The value to assign to the named_credential_id property of this CreateSqlJobDetails.

  • role (str) – The value to assign to the role property of this CreateSqlJobDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSqlJobDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSqlJobDetails.

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 defined_tags

Gets the defined_tags of this CreateSqlJobDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateSqlJobDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateJobDetails. The description of the job.

Returns

The description of this CreateJobDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateSqlJobDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateSqlJobDetails.

Return type

dict(str, 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 in_binds

Gets the in_binds of this CreateSqlJobDetails.

Returns

The in_binds of this CreateSqlJobDetails.

Return type

oci.database_management.models.JobInBindsDetails

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 named_credential_id

Gets the named_credential_id of this CreateSqlJobDetails. The OCID of the Named Credentials containing password secret.

Returns

The named_credential_id of this CreateSqlJobDetails.

Return type

str

property operation_type

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

Returns

The operation_type of this CreateSqlJobDetails.

Return type

str

property out_binds

Gets the out_binds of this CreateSqlJobDetails.

Returns

The out_binds of this CreateSqlJobDetails.

Return type

oci.database_management.models.JobOutBindsDetails

property 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

property result_location

Gets the result_location of this CreateJobDetails.

Returns

The result_location of this CreateJobDetails.

Return type

oci.database_management.models.JobExecutionResultLocation

property 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

property schedule_details

Gets the schedule_details of this CreateJobDetails.

Returns

The schedule_details of this CreateJobDetails.

Return type

oci.database_management.models.JobScheduleDetails

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 secret_id

Gets the secret_id of this CreateSqlJobDetails. The OCID of the secret containing the user password.

Returns

The secret_id of this CreateSqlJobDetails.

Return type

str

property 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

property sql_type

Gets the sql_type of this CreateSqlJobDetails.

Returns

The sql_type of this CreateSqlJobDetails.

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

property 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