Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SensitiveColumnSummary

Summary of a sensitive column present in a sensitive data model.

Properties

appName

appName: string

The name of the application associated with the sensitive column. It's useful when the application name is different from the schema name. Otherwise, it can be ignored.

columnName

columnName: string

The name of the sensitive column.

dataType

dataType: string

The data type of the sensitive column.

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.

key

key: string

The unique key that identifies the sensitive column. It's numeric and unique within a sensitive data model.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Details about the current state of the sensitive column.

lifecycleState

The current state of the sensitive column.

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.

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.

sensitiveDataModelId

sensitiveDataModelId: string

The OCID of the sensitive data model that contains the sensitive column.

Optional sensitiveTypeId

sensitiveTypeId: undefined | string

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

source

source: Source

The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.

status

status: Status

The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.

timeCreated

timeCreated: Date

The date and time, in the format defined by RFC3339, the sensitive column was created in the sensitive data model.

timeUpdated

timeUpdated: Date

The date and time, in the format defined by RFC3339, the sensitive column was last updated in the sensitive data model.

Functions

getDeserializedJsonObj

getJsonObj