Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace JobDefinition

Representation of a job definition resource. 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 default connection resource to be used for harvest, sampling, profiling jobs. This may be overridden in each job instance.

Optional createdById

createdById: undefined | string

OCID of the user who created this job definition.

Optional dataAssetKey

dataAssetKey: undefined | string

The key of the data asset for which the job is defined.

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.

Optional internalVersion

internalVersion: undefined | string

Version of the job definition object. Used internally but can be visible to users.

Optional isIncremental

isIncremental: undefined | false | true

Specifies if the job definition is incremental or full.

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 properties

properties: undefined | object

A map of maps that contains the properties which are specific to the job type. Each job type definition 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 definitions have required properties within the "default" category. Example: {@code {"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}}

Optional sampleDataSizeInMBs

sampleDataSizeInMBs: undefined | number

Specify the sample data size in MB, specified as number of rows, for this metadata harvest. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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 timeUpdated

timeUpdated: Date

The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated this job definition.

Optional uri

uri: undefined | string

URI to the job definition instance in the API.

Functions

getDeserializedJsonObj

getJsonObj