Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace JobExecution

A job execution is a unit of work being executed on behalf of a job.

Properties

Optional createdById

createdById: undefined | string

OCID of the user who created the job execution.

Optional dataEntityKey

dataEntityKey: undefined | string

The key of the associated data entity resource.

Optional errorCode

errorCode: undefined | string

Error code returned from the job execution or null if job is still running or didn't return an error.

Optional errorMessage

errorMessage: undefined | string

Error message returned from the job execution or null if job is still running or didn't return an error.

Optional eventKey

eventKey: undefined | string

An identifier used for log message correlation.

Optional externalUrl

externalUrl: undefined | string

If the job is an external process, then a URL of the job for accessing this resource and its status.

Optional jobKey

jobKey: undefined | string

The unique key of the parent job.

Optional jobType

jobType: model.JobType

Type of the job execution.

key

key: string

Unique key of the job execution resource.

Optional lifecycleState

lifecycleState: model.JobExecutionState

Status of the job execution, such as running, paused, or completed.

Optional parentKey

parentKey: undefined | string

The unique key of the parent execution or null if this job execution has no parent.

Optional processKey

processKey: undefined | string

Process identifier related to the job execution if the job is an external job.

Optional properties

properties: undefined | object

A map of maps that contains the execution context properties which are specific to a job execution. Each job execution may define it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job executions have required properties within the "default" category. Example: {@code {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}}

Optional scheduleInstanceKey

scheduleInstanceKey: undefined | string

The unique key of the triggering external scheduler resource or null if this job execution is not externally triggered.

Optional subType

subType: undefined | string

Sub-type of this job execution.

Optional timeCreated

timeCreated: Date

The date and time the job execution was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional timeEnded

timeEnded: Date

Time that the job execution ended or null if it hasn't yet completed. An RFC3339 formatted datetime string.

Optional timeStarted

timeStarted: Date

Time that job execution started. An RFC3339 formatted datetime string.

Optional updatedBy

updatedBy: undefined | string

OCID of the user who updated the job execution.

Optional uri

uri: undefined | string

URI to the job execution instance in the API.

Functions

getDeserializedJsonObj

getJsonObj