Class: OCI::DataSafe::Models::SensitiveType
- Inherits:
-
Object
- Object
- OCI::DataSafe::Models::SensitiveType
- Defined in:
- lib/oci/data_safe/models/sensitive_type.rb
Overview
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.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
Constant Summary collapse
- ENTITY_TYPE_ENUM =
[ ENTITY_TYPE_SENSITIVE_TYPE = 'SENSITIVE_TYPE'.freeze, ENTITY_TYPE_SENSITIVE_CATEGORY = 'SENSITIVE_CATEGORY'.freeze, ENTITY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- 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
- SOURCE_ENUM =
[ SOURCE_ORACLE = 'ORACLE'.freeze, SOURCE_USER = 'USER'.freeze, SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the sensitive type.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the sensitive type.
-
#display_name ⇒ String
[Required] The display name of the sensitive type.
-
#entity_type ⇒ String
[Required] The entity type.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the sensitive type.
-
#lifecycle_state ⇒ String
[Required] The current state of the sensitive type.
-
#parent_category_id ⇒ String
The OCID of the parent sensitive category.
-
#short_name ⇒ String
The short name of the sensitive type.
-
#source ⇒ String
[Required] Specifies whether the sensitive type is user-defined or predefined.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time the sensitive type was created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
[Required] The date and time the sensitive type 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.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.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 = {}) ⇒ SensitiveType
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 = {}) ⇒ SensitiveType
Initializes the object
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 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 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 184 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.entity_type = attributes[:'entityType'] if attributes[:'entityType'] raise 'You cannot provide both :entityType and :entity_type' if attributes.key?(:'entityType') && attributes.key?(:'entity_type') self.entity_type = attributes[:'entity_type'] if attributes[:'entity_type'] 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.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.short_name = attributes[:'shortName'] if attributes[:'shortName'] raise 'You cannot provide both :shortName and :short_name' if attributes.key?(:'shortName') && attributes.key?(:'short_name') self.short_name = attributes[:'short_name'] if attributes[:'short_name'] self.source = attributes[:'source'] if attributes[:'source'] 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.description = attributes[:'description'] if attributes[:'description'] self.parent_category_id = attributes[:'parentCategoryId'] if attributes[:'parentCategoryId'] raise 'You cannot provide both :parentCategoryId and :parent_category_id' if attributes.key?(:'parentCategoryId') && attributes.key?(:'parent_category_id') self.parent_category_id = attributes[:'parent_category_id'] if attributes[:'parent_category_id'] 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
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the sensitive type.
54 55 56 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 54 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\"}}
96 97 98 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 96 def @defined_tags end |
#description ⇒ String
The description of the sensitive type.
78 79 80 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 78 def description @description end |
#display_name ⇒ String
[Required] The display name of the sensitive type.
50 51 52 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 50 def display_name @display_name end |
#entity_type ⇒ String
[Required] The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.
46 47 48 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 46 def entity_type @entity_type 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\"}
89 90 91 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 89 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the sensitive type.
40 41 42 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 40 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the sensitive type.
58 59 60 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 58 def lifecycle_state @lifecycle_state end |
#parent_category_id ⇒ String
The OCID of the parent sensitive category.
82 83 84 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 82 def parent_category_id @parent_category_id end |
#short_name ⇒ String
The short name of the sensitive type.
62 63 64 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 62 def short_name @short_name end |
#source ⇒ String
[Required] Specifies whether the sensitive type is user-defined or predefined.
66 67 68 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 66 def source @source 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\"}}
102 103 104 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 102 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time the sensitive type was created, in the format defined by RFC3339.
70 71 72 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 70 def time_created @time_created end |
#time_updated ⇒ DateTime
[Required] The date and time the sensitive type was last updated, in the format defined by RFC3339.
74 75 76 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 74 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 105 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'entity_type': :'entityType', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'lifecycle_state': :'lifecycleState', 'short_name': :'shortName', 'source': :'source', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'description': :'description', 'parent_category_id': :'parentCategoryId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
153 154 155 156 157 158 159 160 161 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 153 def self.get_subtype(object_hash) type = object_hash[:'entityType'] # rubocop:disable Style/SymbolLiteral return 'OCI::DataSafe::Models::SensitiveTypePattern' if type == 'SENSITIVE_TYPE' return 'OCI::DataSafe::Models::SensitiveCategory' if type == 'SENSITIVE_CATEGORY' # TODO: Log a warning when the subtype is not found. 'OCI::DataSafe::Models::SensitiveType' end |
.swagger_types ⇒ Object
Attribute type mapping.
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 127 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'entity_type': :'String', 'display_name': :'String', 'compartment_id': :'String', 'lifecycle_state': :'String', 'short_name': :'String', 'source': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'description': :'String', 'parent_category_id': :'String', '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.
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 309 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && entity_type == other.entity_type && display_name == other.display_name && compartment_id == other.compartment_id && lifecycle_state == other.lifecycle_state && short_name == other.short_name && source == other.source && time_created == other.time_created && time_updated == other.time_updated && description == other.description && parent_category_id == other.parent_category_id && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 352 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
332 333 334 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 332 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
341 342 343 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 341 def hash [id, entity_type, display_name, compartment_id, lifecycle_state, short_name, source, time_created, time_updated, description, parent_category_id, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
385 386 387 388 389 390 391 392 393 394 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 385 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
379 380 381 |
# File 'lib/oci/data_safe/models/sensitive_type.rb', line 379 def to_s to_hash.to_s end |