Class DiscoveryJobResultSummary

Summary of a discovery job result.

Inheritance

object

DiscoveryJobResultSummary

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 DiscoveryJobResultSummary

Properties

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

DiscoveryJobId

Declaration

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

Property Value

Type	Description
string	The OCID of the discovery job.

Remarks

Required

DiscoveryType

Declaration

[Required(ErrorMessage = "DiscoveryType is required.")]
[JsonProperty(PropertyName = "discoveryType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DiscoveryJobResult.DiscoveryTypeEnum? DiscoveryType { get; set; }

Property Value

Type	Description
DiscoveryJobResult.DiscoveryTypeEnum?	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.

Type

Description

DiscoveryJobResult.DiscoveryTypeEnum?

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.

Remarks

Required

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

IsResultApplied

Declaration

[Required(ErrorMessage = "IsResultApplied is required.")]
[JsonProperty(PropertyName = "isResultApplied")]
public bool? IsResultApplied { get; set; }

Property Value

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

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 discovery result.

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 DiscoveryJobResultSummary.ObjectTypeEnum? ObjectType { get; set; }

Property Value

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

PlannedAction

Declaration

[Required(ErrorMessage = "PlannedAction is required.")]
[JsonProperty(PropertyName = "plannedAction")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DiscoveryJobResult.PlannedActionEnum? PlannedAction { get; set; }

Property Value

Type	Description
DiscoveryJobResult.PlannedActionEnum?	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.

Type

Description

DiscoveryJobResult.PlannedActionEnum?

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.

Remarks

Required

RelationType

Declaration

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

Property Value

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

SensitiveColumnkey

Declaration

[JsonProperty(PropertyName = "sensitiveColumnkey")]
public string SensitiveColumnkey { get; set; }

Property Value

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

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.