Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DiscoveryJob

A data discovery job. It helps track job's metadata as well as result statistics.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the discovery job.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

discoveryType

discoveryType: DiscoveryType

The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

displayName

displayName: string

The display name of the discovery job.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the discovery job.

isAppDefinedRelationDiscoveryEnabled

isAppDefinedRelationDiscoveryEnabled: boolean

Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships.

isIncludeAllSchemas

isIncludeAllSchemas: boolean

Indicates if all the schemas in the associated target database are used for data discovery. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).

isIncludeAllSensitiveTypes

isIncludeAllSensitiveTypes: boolean

Indicates if all the existing sensitive types are used for data discovery. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

isSampleDataCollectionEnabled

isSampleDataCollectionEnabled: boolean

Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

lifecycleState

lifecycleState: DiscoveryLifecycleState

The current state of the discovery job.

Optional schemasForDiscovery

schemasForDiscovery: Array<string>

The schemas used for data discovery.

sensitiveDataModelId

sensitiveDataModelId: string

The OCID of the sensitive data model associated with the discovery job.

Optional sensitiveTypeIdsForDiscovery

sensitiveTypeIdsForDiscovery: Array<string>

The OCIDs of the sensitive types used for data discovery.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

targetId

targetId: string

The OCID of the target database associated with the discovery job.

timeFinished

timeFinished: Date

The date and time the discovery job finished, in the format defined by RFC3339..

timeStarted

timeStarted: Date

The date and time the discovery job started, in the format defined by RFC3339.

totalColumnsScanned

totalColumnsScanned: number

The total number of columns scanned by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalDeletedSensitiveColumns

totalDeletedSensitiveColumns: number

The total number of deleted sensitive columns identified by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalModifiedSensitiveColumns

totalModifiedSensitiveColumns: number

The total number of modified sensitive columns identified by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalNewSensitiveColumns

totalNewSensitiveColumns: number

The total number of new sensitive columns identified by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalObjectsScanned

totalObjectsScanned: number

The total number of objects (tables and editioning views) scanned by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

totalSchemasScanned

totalSchemasScanned: number

The total number of schemas scanned by the discovery job. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj