Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace JobSummary

Details of a job. Jobs are scheduled instances of a job definition.

Properties

Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional createdById

createdById: undefined | string

OCID of the user who created this job.

Optional dataAssetKey

dataAssetKey: undefined | string

Unique key of the data asset to which this job applies, if the job involves a data asset.

Optional description

description: undefined | string

Detailed description of the job.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional errorCode

errorCode: undefined | string

Error code returned from the latest job execution for this job. Useful when the latest Job execution is in FAILED state.

Optional errorMessage

errorMessage: undefined | string

Error message returned from the latest job execution for this job. Useful when the latest Job Execution is in a FAILED state.

Optional executionCount

executionCount: undefined | number

The total number of executions for this job schedule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional executions

Array of the executions summary associated with this job.

Optional glossaryKey

glossaryKey: undefined | string

Unique key of the glossary to which this job applies.

Optional jobDefinitionKey

jobDefinitionKey: undefined | string

The unique key of the job definition resource that defined the scope of this job.

Optional jobDefinitionName

jobDefinitionName: undefined | string

The display name of the job definition resource that defined the scope of this job.

Optional jobType

jobType: model.JobType

Type of the job.

key

key: string

Unique key of the job.

Optional lifecycleState

lifecycleState: model.JobLifecycleState

Lifecycle state of the job, such as running, paused, or completed.

Optional scheduleCronExpression

scheduleCronExpression: undefined | string

Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

Optional scheduleType

scheduleType: undefined | string

Type of job schedule that is inferred from the scheduling properties.

Optional timeCreated

timeCreated: Date

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

Optional timeOfLatestExecution

timeOfLatestExecution: Date

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

Optional timeScheduleBegin

timeScheduleBegin: Date

Date that the schedule should be operational. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

Time that this job was last updated. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated this job.

Optional uri

uri: undefined | string

URI to the job instance in the API.

Functions

getDeserializedJsonObj

getJsonObj