Class SensitiveColumn

A sensitive column is a resource corresponding to a database column that is considered sensitive. It's a subresource of sensitive data model resource and is always associated with a sensitive data model. Note that referential relationships are also managed as part of sensitive columns.

Inheritance

object

SensitiveColumn

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatasafeService.Models

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class SensitiveColumn

Properties

AppDefinedChildColumnKeys

Declaration

[JsonProperty(PropertyName = "appDefinedChildColumnKeys")]
public List<string> AppDefinedChildColumnKeys { get; set; }

Property Value

Type	Description
List<string>	Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

AppName

Declaration

[Required(ErrorMessage = "AppName is required.")]
[JsonProperty(PropertyName = "appName")]
public string AppName { get; set; }

Property Value

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

Remarks

Required

ColumnGroups

Declaration

[JsonProperty(PropertyName = "columnGroups")]
public List<string> ColumnGroups { get; set; }

Property Value

Type	Description
List<string>	The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it's assigned a column group. It helps identify and manage referential relationships that involve composite keys.

ColumnName

Declaration

[Required(ErrorMessage = "ColumnName is required.")]
[JsonProperty(PropertyName = "columnName")]
public string ColumnName { get; set; }

Property Value

Type	Description
string	The name of the sensitive column.

Remarks

Required

DataType

Declaration

[Required(ErrorMessage = "DataType is required.")]
[JsonProperty(PropertyName = "dataType")]
public string DataType { get; set; }

Property Value

Type	Description
string	The data type of the sensitive column.

Remarks

Required

DbDefinedChildColumnKeys

Declaration

[JsonProperty(PropertyName = "dbDefinedChildColumnKeys")]
public List<string> DbDefinedChildColumnKeys { get; set; }

Property Value

Type	Description
List<string>	Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

EstimatedDataValueCount

Declaration

[Required(ErrorMessage = "EstimatedDataValueCount is required.")]
[JsonProperty(PropertyName = "estimatedDataValueCount")]
public long? EstimatedDataValueCount { get; set; }

Property Value

Type	Description
long?	The estimated number of data values the column has in the associated database.

Remarks

Required

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

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

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Details about the current state of the sensitive column.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveColumnLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
SensitiveColumnLifecycleState?	The current state of the sensitive column.

Remarks

Required

ObjectName

Declaration

[Required(ErrorMessage = "ObjectName is required.")]
[JsonProperty(PropertyName = "objectName")]
public string ObjectName { get; set; }

Property Value

Type	Description
string	The database object that contains the sensitive column.

Remarks

Required

ObjectType

Declaration

[Required(ErrorMessage = "ObjectType is required.")]
[JsonProperty(PropertyName = "objectType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveColumn.ObjectTypeEnum? ObjectType { get; set; }

Property Value

Type	Description
SensitiveColumn.ObjectTypeEnum?	The type of the database object that contains the sensitive column.

Remarks

Required

ParentColumnKeys

Declaration

[JsonProperty(PropertyName = "parentColumnKeys")]
public List<string> ParentColumnKeys { get; set; }

Property Value

Type	Description
List<string>	Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

RelationType

Declaration

[Required(ErrorMessage = "RelationType is required.")]
[JsonProperty(PropertyName = "relationType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveColumn.RelationTypeEnum? RelationType { get; set; }

Property Value

Type	Description
SensitiveColumn.RelationTypeEnum?	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.

Remarks

Required

SampleDataValues

Declaration

[JsonProperty(PropertyName = "sampleDataValues")]
public List<string> SampleDataValues { get; set; }

Property Value

Type	Description
List<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

Declaration

[Required(ErrorMessage = "SchemaName is required.")]
[JsonProperty(PropertyName = "schemaName")]
public string SchemaName { get; set; }

Property Value

Type	Description
string	The database schema that contains the sensitive column.

Remarks

Required

SensitiveDataModelId

Declaration

[Required(ErrorMessage = "SensitiveDataModelId is required.")]
[JsonProperty(PropertyName = "sensitiveDataModelId")]
public string SensitiveDataModelId { get; set; }

Property Value

Type	Description
string	The OCID of the sensitive data model that contains the sensitive column.

Remarks

Required

SensitiveTypeId

Declaration

[JsonProperty(PropertyName = "sensitiveTypeId")]
public string SensitiveTypeId { get; set; }

Property Value

Type	Description
string	The OCID of the sensitive type associated with the sensitive column.

Source

Declaration

[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveColumn.SourceEnum? Source { get; set; }

Property Value

Type	Description
SensitiveColumn.SourceEnum?	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.

Remarks

Required

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveColumn.StatusEnum? Status { get; set; }

Property Value

Type	Description
SensitiveColumn.StatusEnum?	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.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

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

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

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

Remarks

Required