Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateJobDefinitionDetails

Update information for a job definition resource.

Properties

Optional connectionKey

connectionKey: undefined | string

The key of the connection resource to be used for harvest, sampling, profiling jobs.

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