Class CreateSensitiveColumnDetails

Details to create a new sensitive column in a sensitive data model.

Inheritance

object

CreateSensitiveColumnDetails

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 CreateSensitiveColumnDetails

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. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

Type

Description

List<string>

Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

AppName

Declaration

[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. If this attribute is not provided, it's automatically populated with the value provided for the schemaName attribute.

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

[JsonProperty(PropertyName = "dataType")]
public string DataType { get; set; }

Property Value

Type	Description
string	The data type of the sensitive column.

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. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

Type

Description

List<string>

Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

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

[JsonProperty(PropertyName = "objectType")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateSensitiveColumnDetails.ObjectTypeEnum? ObjectType { get; set; }

Property Value

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

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 accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship.

Type

Description

List<string>

Unique keys identifying the columns that are parents of the sensitive column. At present, it accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship.

RelationType

Declaration

[JsonProperty(PropertyName = "relationType")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateSensitiveColumnDetails.RelationTypeEnum? RelationType { get; set; }

Property Value

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

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

SensitiveTypeId

Declaration

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

Property Value

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

Status

Declaration

[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateSensitiveColumnDetails.StatusEnum? Status { get; set; }

Property Value

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