Class CreateDiscoveryJobDetails
Details to create a new data discovery job.
Inherited Members
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class CreateDiscoveryJobDetails
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment where the discovery job resource should be created. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags
|
DiscoveryType
Declaration
[JsonProperty(PropertyName = "discoveryType")]
[JsonConverter(typeof(StringEnumConverter))]
public DiscoveryJob.DiscoveryTypeEnum? DiscoveryType { get; set; }
Property Value
Type | Description |
---|---|
DiscoveryJob.DiscoveryTypeEnum? | The type of the discovery job. It defines the job's scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns. |
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information. |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags
|
IsAppDefinedRelationDiscoveryEnabled
Declaration
[JsonProperty(PropertyName = "isAppDefinedRelationDiscoveryEnabled")]
public bool? IsAppDefinedRelationDiscoveryEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns. Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It's disabled by default and should be used only if there is a need to identify application-level relationships. |
IsIncludeAllSchemas
Declaration
[JsonProperty(PropertyName = "isIncludeAllSchemas")]
public bool? IsIncludeAllSchemas { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if all the schemas should be scanned by the discovery job. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). If both attributes are not provided, the configuration from the sensitive data model is used. |
IsIncludeAllSensitiveTypes
Declaration
[JsonProperty(PropertyName = "isIncludeAllSensitiveTypes")]
public bool? IsIncludeAllSensitiveTypes { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if all the existing sensitive types should be used by the discovery job. If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used. |
IsSampleDataCollectionEnabled
Declaration
[JsonProperty(PropertyName = "isSampleDataCollectionEnabled")]
public bool? IsSampleDataCollectionEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if the discovery job should collect and store sample data values for the discovered columns. Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it's disabled by default and should be used only if it's acceptable to store sample data in Data Safe's repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE. |
SchemasForDiscovery
Declaration
[JsonProperty(PropertyName = "schemasForDiscovery")]
public List<string> SchemasForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas. |
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. |
Remarks
Required
SensitiveTypeIdsForDiscovery
Declaration
[JsonProperty(PropertyName = "sensitiveTypeIdsForDiscovery")]
public List<string> SensitiveTypeIdsForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<string> | The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types. |
TablesForDiscovery
Declaration
[JsonProperty(PropertyName = "tablesForDiscovery")]
public List<TablesForDiscovery> TablesForDiscovery { get; set; }
Property Value
Type | Description |
---|---|
List<TablesForDiscovery> | The data discovery jobs will scan the tables specified here, including both schemas and tables. In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model. |