Class: OCI::DataSafe::Models::SensitiveDataModel
- Inherits:
-
Object
- Object
- OCI::DataSafe::Models::SensitiveDataModel
- Defined in:
- lib/oci/data_safe/models/sensitive_data_model.rb
Overview
A sensitive data model is a collection of sensitive columns and their referential relationships. It helps understand the sensitive data landscape, track changes, and efficiently enable security controls such as data masking. It can be managed either manually or by performing sensitive data discovery on a reference target database. Learn more.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#app_suite_name ⇒ String
[Required] The application suite name identifying a collection of applications.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the sensitive data model.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the sensitive data model.
-
#display_name ⇒ String
[Required] The display name of the sensitive data model.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the sensitive data model.
-
#is_app_defined_relation_discovery_enabled ⇒ BOOLEAN
[Required] Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns.
-
#is_include_all_schemas ⇒ BOOLEAN
[Required] Indicates if all the schemas in the associated target database should be scanned by data discovery jobs.
-
#is_include_all_sensitive_types ⇒ BOOLEAN
[Required] Indicates if all the existing sensitive types should be used by data discovery jobs.If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
-
#is_sample_data_collection_enabled ⇒ BOOLEAN
[Required] Indicates if data discovery jobs should collect and store sample data values for the discovered columns.
-
#lifecycle_state ⇒ String
[Required] The current state of the sensitive data model.
-
#schemas_for_discovery ⇒ Array<String>
The schemas to be scanned by data discovery jobs.
-
#sensitive_type_ids_for_discovery ⇒ Array<String>
The OCIDs of the sensitive types to be used by data discovery jobs.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#target_id ⇒ String
[Required] The OCID of the reference target database associated with the sensitive data model.
-
#time_created ⇒ DateTime
[Required] The date and time the sensitive data model was created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
[Required] The date and time the sensitive data model was last updated, in the format defined by RFC3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SensitiveDataModel
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SensitiveDataModel
Initializes the object
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 200 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.id = attributes[:'id'] if attributes[:'id'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.target_id = attributes[:'targetId'] if attributes[:'targetId'] raise 'You cannot provide both :targetId and :target_id' if attributes.key?(:'targetId') && attributes.key?(:'target_id') self.target_id = attributes[:'target_id'] if attributes[:'target_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.app_suite_name = attributes[:'appSuiteName'] if attributes[:'appSuiteName'] raise 'You cannot provide both :appSuiteName and :app_suite_name' if attributes.key?(:'appSuiteName') && attributes.key?(:'app_suite_name') self.app_suite_name = attributes[:'app_suite_name'] if attributes[:'app_suite_name'] self.description = attributes[:'description'] if attributes[:'description'] self.schemas_for_discovery = attributes[:'schemasForDiscovery'] if attributes[:'schemasForDiscovery'] raise 'You cannot provide both :schemasForDiscovery and :schemas_for_discovery' if attributes.key?(:'schemasForDiscovery') && attributes.key?(:'schemas_for_discovery') self.schemas_for_discovery = attributes[:'schemas_for_discovery'] if attributes[:'schemas_for_discovery'] self.sensitive_type_ids_for_discovery = attributes[:'sensitiveTypeIdsForDiscovery'] if attributes[:'sensitiveTypeIdsForDiscovery'] raise 'You cannot provide both :sensitiveTypeIdsForDiscovery and :sensitive_type_ids_for_discovery' if attributes.key?(:'sensitiveTypeIdsForDiscovery') && attributes.key?(:'sensitive_type_ids_for_discovery') self.sensitive_type_ids_for_discovery = attributes[:'sensitive_type_ids_for_discovery'] if attributes[:'sensitive_type_ids_for_discovery'] self.is_sample_data_collection_enabled = attributes[:'isSampleDataCollectionEnabled'] unless attributes[:'isSampleDataCollectionEnabled'].nil? raise 'You cannot provide both :isSampleDataCollectionEnabled and :is_sample_data_collection_enabled' if attributes.key?(:'isSampleDataCollectionEnabled') && attributes.key?(:'is_sample_data_collection_enabled') self.is_sample_data_collection_enabled = attributes[:'is_sample_data_collection_enabled'] unless attributes[:'is_sample_data_collection_enabled'].nil? self.is_app_defined_relation_discovery_enabled = attributes[:'isAppDefinedRelationDiscoveryEnabled'] unless attributes[:'isAppDefinedRelationDiscoveryEnabled'].nil? raise 'You cannot provide both :isAppDefinedRelationDiscoveryEnabled and :is_app_defined_relation_discovery_enabled' if attributes.key?(:'isAppDefinedRelationDiscoveryEnabled') && attributes.key?(:'is_app_defined_relation_discovery_enabled') self.is_app_defined_relation_discovery_enabled = attributes[:'is_app_defined_relation_discovery_enabled'] unless attributes[:'is_app_defined_relation_discovery_enabled'].nil? self.is_include_all_schemas = attributes[:'isIncludeAllSchemas'] unless attributes[:'isIncludeAllSchemas'].nil? raise 'You cannot provide both :isIncludeAllSchemas and :is_include_all_schemas' if attributes.key?(:'isIncludeAllSchemas') && attributes.key?(:'is_include_all_schemas') self.is_include_all_schemas = attributes[:'is_include_all_schemas'] unless attributes[:'is_include_all_schemas'].nil? self.is_include_all_sensitive_types = attributes[:'isIncludeAllSensitiveTypes'] unless attributes[:'isIncludeAllSensitiveTypes'].nil? raise 'You cannot provide both :isIncludeAllSensitiveTypes and :is_include_all_sensitive_types' if attributes.key?(:'isIncludeAllSensitiveTypes') && attributes.key?(:'is_include_all_sensitive_types') self.is_include_all_sensitive_types = attributes[:'is_include_all_sensitive_types'] unless attributes[:'is_include_all_sensitive_types'].nil? self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#app_suite_name ⇒ String
[Required] The application suite name identifying a collection of applications. The default value is GENERIC. It's useful only if maintaining a sensitive data model for a suite of applications.
60 61 62 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 60 def app_suite_name @app_suite_name end |
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the sensitive data model.
36 37 38 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 36 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
116 117 118 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 116 def @defined_tags end |
#description ⇒ String
The description of the sensitive data model.
64 65 66 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 64 def description @description end |
#display_name ⇒ String
[Required] The display name of the sensitive data model.
32 33 34 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 32 def display_name @display_name end |
#freeform_tags ⇒ Hash<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
Example: {\"Department\": \"Finance\"}
109 110 111 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 109 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the sensitive data model.
28 29 30 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 28 def id @id end |
#is_app_defined_relation_discovery_enabled ⇒ BOOLEAN
[Required] Indicates if data discovery jobs 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.
90 91 92 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 90 def is_app_defined_relation_discovery_enabled @is_app_defined_relation_discovery_enabled end |
#is_include_all_schemas ⇒ BOOLEAN
[Required] Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).
96 97 98 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 96 def is_include_all_schemas @is_include_all_schemas end |
#is_include_all_sensitive_types ⇒ BOOLEAN
[Required] Indicates if all the existing sensitive types should be used by data discovery jobs.If it's set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
102 103 104 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 102 def is_include_all_sensitive_types @is_include_all_sensitive_types end |
#is_sample_data_collection_enabled ⇒ BOOLEAN
[Required] Indicates if data discovery jobs 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.
81 82 83 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 81 def is_sample_data_collection_enabled @is_sample_data_collection_enabled end |
#lifecycle_state ⇒ String
[Required] The current state of the sensitive data model.
54 55 56 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 54 def lifecycle_state @lifecycle_state end |
#schemas_for_discovery ⇒ Array<String>
The schemas to be scanned by data discovery jobs.
68 69 70 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 68 def schemas_for_discovery @schemas_for_discovery end |
#sensitive_type_ids_for_discovery ⇒ Array<String>
The OCIDs of the sensitive types to be used by data discovery jobs.
72 73 74 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 72 def sensitive_type_ids_for_discovery @sensitive_type_ids_for_discovery end |
#system_tags ⇒ Hash<String, Hash<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\"}}
122 123 124 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 122 def @system_tags end |
#target_id ⇒ String
[Required] The OCID of the reference target database associated with the sensitive data model. All operations such as performing data discovery and adding columns manually are done in the context of the associated target database.
42 43 44 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 42 def target_id @target_id end |
#time_created ⇒ DateTime
[Required] The date and time the sensitive data model was created, in the format defined by RFC3339.
46 47 48 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 46 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The date and time the sensitive data model was last updated, in the format defined by RFC3339.
50 51 52 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 50 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 125 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'target_id': :'targetId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'app_suite_name': :'appSuiteName', 'description': :'description', 'schemas_for_discovery': :'schemasForDiscovery', 'sensitive_type_ids_for_discovery': :'sensitiveTypeIdsForDiscovery', 'is_sample_data_collection_enabled': :'isSampleDataCollectionEnabled', 'is_app_defined_relation_discovery_enabled': :'isAppDefinedRelationDiscoveryEnabled', 'is_include_all_schemas': :'isIncludeAllSchemas', 'is_include_all_sensitive_types': :'isIncludeAllSensitiveTypes', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 151 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'target_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'app_suite_name': :'String', 'description': :'String', 'schemas_for_discovery': :'Array<String>', 'sensitive_type_ids_for_discovery': :'Array<String>', 'is_sample_data_collection_enabled': :'BOOLEAN', 'is_app_defined_relation_discovery_enabled': :'BOOLEAN', 'is_include_all_schemas': :'BOOLEAN', 'is_include_all_sensitive_types': :'BOOLEAN', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 327 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && target_id == other.target_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && app_suite_name == other.app_suite_name && description == other.description && schemas_for_discovery == other.schemas_for_discovery && sensitive_type_ids_for_discovery == other.sensitive_type_ids_for_discovery && is_sample_data_collection_enabled == other.is_sample_data_collection_enabled && is_app_defined_relation_discovery_enabled == other.is_app_defined_relation_discovery_enabled && is_include_all_schemas == other.is_include_all_schemas && is_include_all_sensitive_types == other.is_include_all_sensitive_types && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 374 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
354 355 356 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 354 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
363 364 365 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 363 def hash [id, display_name, compartment_id, target_id, time_created, time_updated, lifecycle_state, app_suite_name, description, schemas_for_discovery, sensitive_type_ids_for_discovery, is_sample_data_collection_enabled, is_app_defined_relation_discovery_enabled, is_include_all_schemas, is_include_all_sensitive_types, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
407 408 409 410 411 412 413 414 415 416 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 407 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
401 402 403 |
# File 'lib/oci/data_safe/models/sensitive_data_model.rb', line 401 def to_s to_hash.to_s end |