Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace DiscoveryJobResult

A discovery job result representing a sensitive column. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

Properties

Optional appDefinedChildColumnKeys

appDefinedChildColumnKeys: Array<string>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

Optional appName

appName: undefined | string

The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

columnName

columnName: string

The name of the sensitive column.

dataType

dataType: string

The data type of the sensitive column.

Optional dbDefinedChildColumnKeys

dbDefinedChildColumnKeys: Array<string>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

discoveryJobId

discoveryJobId: string

The OCID of the discovery job.

discoveryType

discoveryType: DiscoveryType

The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

estimatedDataValueCount

estimatedDataValueCount: number

The estimated number of data values the column has in the associated database. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

isResultApplied

isResultApplied: boolean

Indicates whether the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

key

key: string

The unique key that identifies the discovery result.

Optional modifiedAttributes

modifiedAttributes: model.ModifiedAttributes

objectName

objectName: string

The database object that contains the sensitive column.

objectType

objectType: ObjectType

The type of the database object that contains the sensitive column.

Optional parentColumnKeys

parentColumnKeys: Array<string>

Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

plannedAction

plannedAction: PlannedAction

Specifies how to process the discovery result. It's set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn't change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren't reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

relationType

relationType: RelationType

The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

Optional sampleDataValues

sampleDataValues: Array<string>

Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

schemaName

schemaName: string

The database schema that contains the sensitive column.

Optional sensitiveColumnkey

sensitiveColumnkey: undefined | string

The unique key that identifies the sensitive column represented by the discovery result.

Optional sensitiveTypeId

sensitiveTypeId: undefined | string

The OCID of the sensitive type associated with the sensitive column.

Functions

getDeserializedJsonObj

getJsonObj