Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace JobDefinitionSummary

A list of job definition resources. Job definitions define the harvest scope and includes the list of objects to be harvested along with a schedule. The list of objects is usually specified through a combination of object type, regular expressions, or specific names of objects and a sample size for the data harvested.

Properties

Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional connectionKey

connectionKey: undefined | string

The key of the connection resource used in harvest, sampling, profiling jobs.

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

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 glossaryKey

glossaryKey: undefined | string

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

Optional isSampleDataExtracted

isSampleDataExtracted: undefined | false | true

Specify if sample data to be extracted as part of this harvest.

Optional jobExecutionState

jobExecutionState: model.JobExecutionState

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

Optional jobType

jobType: model.JobType

Type of the job definition.

key

key: string

Unique key of the job definition resource that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

Lifecycle state of the job definition.

Optional scheduleType

scheduleType: model.JobScheduleType

Type of job schedule for the latest job executed.

Optional timeCreated

timeCreated: Date

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

Optional timeLatestExecutionEnded

timeLatestExecutionEnded: Date

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

Optional timeLatestExecutionStarted

timeLatestExecutionStarted: Date

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

Optional uri

uri: undefined | string

URI to the job definition instance in the API.

Functions

getDeserializedJsonObj

getJsonObj