Class SensitiveType
A sensitive type defines a particular type or class of sensitive data. It can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types. Learn more.
Inherited Members
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
[JsonConverter(typeof(SensitiveTypeModelConverter))]
public class SensitiveType
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 that contains the sensitive type. |
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
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | The description of the sensitive type. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The display name of the sensitive type. |
Remarks
Required
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
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the sensitive type. |
Remarks
Required
IsCommon
Declaration
[JsonProperty(PropertyName = "isCommon")]
public bool? IsCommon { get; set; }
Property Value
Type | Description |
---|---|
bool? | Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DiscoveryLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
DiscoveryLifecycleState? | The current state of the sensitive type. |
Remarks
Required
ParentCategoryId
Declaration
[JsonProperty(PropertyName = "parentCategoryId")]
public string ParentCategoryId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the parent sensitive category. |
ShortName
Declaration
[JsonProperty(PropertyName = "shortName")]
public string ShortName { get; set; }
Property Value
Type | Description |
---|---|
string | The short name of the sensitive type. |
Source
Declaration
[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SensitiveTypeSource? Source { get; set; }
Property Value
Type | Description |
---|---|
SensitiveTypeSource? | Specifies whether the sensitive type is user-defined or predefined. |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the sensitive type was created, in the format defined by RFC3339. |
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 the sensitive type was last updated, in the format defined by RFC3339. |
Remarks
Required