Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SqlJob

The details of the SQL job.

Properties

compartmentId

compartmentId: string

The OCID of the compartment in which the job resides.

Optional databaseSubType

databaseSubType: model.DatabaseSubType

The subtype of the Oracle Database where the job has to be executed. Applicable only when managedDatabaseGroupId is provided.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

The description of the job.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the job.

Optional inBinds

inBinds: model.JobInBindsDetails

Const jobType

jobType: string = "SQL"

lifecycleState

lifecycleState: LifecycleState

The lifecycle state of the job.

Optional managedDatabaseGroupId

managedDatabaseGroupId: undefined | string

The OCID of the Managed Database Group where the job has to be executed.

Optional managedDatabaseId

managedDatabaseId: undefined | string

The OCID of the Managed Database where the job has to be executed.

Optional managedDatabasesDetails

managedDatabasesDetails: Array<JobDatabase>

The details of the Managed Databases where the job has to be executed.

name

name: string

The display name of the job.

Optional namedCredentialId

namedCredentialId: undefined | string

The OCID of the Named Credentials containing password secret.

operationType

operationType: OperationType

The SQL operation type.

Optional outBinds

outBinds: model.JobOutBindsDetails

Optional resultLocation

resultLocation: model.ObjectStorageJobExecutionResultLocation

Optional role

role: Role

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

Optional scheduleDetails

scheduleDetails: model.JobScheduleDetails

scheduleType

scheduleType: ScheduleType

The schedule type of the job.

Optional sqlText

sqlText: undefined | string

The SQL text to be executed in the job. This is a mandatory field for the EXECUTE_SQL operationType.

Optional sqlType

sqlType: SqlType

The type of SQL. This is a mandatory field for the EXECUTE_SQL operationType.

Optional submissionErrorMessage

submissionErrorMessage: undefined | string

The error message that is returned if the job submission fails. Null is returned in all other scenarios.

timeCreated

timeCreated: Date

The date and time when the job was created.

timeUpdated

timeUpdated: Date

The date and time when the job was last updated.

Optional timeout

timeout: undefined | string

The job timeout duration, which is expressed like "1h 10m 15s".

Optional userName

userName: undefined | string

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.

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Job): object

getJsonObj

  • getJsonObj(obj: Job): object