Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateJobDefinitionDetails

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 connectionKey

connectionKey: undefined | string

The key of the connection resource to be used for the job.

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.

displayName

displayName: 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 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.

jobType

jobType: JobType

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

Functions

getDeserializedJsonObj

getJsonObj