Class: OCI::KeyManagement::Models::Key
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::Key
- Defined in:
- lib/oci/key_management/models/key.rb
Overview
Key model.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ENABLING = 'ENABLING'.freeze, LIFECYCLE_STATE_ENABLED = 'ENABLED'.freeze, LIFECYCLE_STATE_DISABLING = 'DISABLING'.freeze, LIFECYCLE_STATE_DISABLED = 'DISABLED'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_PENDING_DELETION = 'PENDING_DELETION'.freeze, LIFECYCLE_STATE_SCHEDULING_DELETION = 'SCHEDULING_DELETION'.freeze, LIFECYCLE_STATE_CANCELLING_DELETION = 'CANCELLING_DELETION'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_BACKUP_IN_PROGRESS = 'BACKUP_IN_PROGRESS'.freeze, LIFECYCLE_STATE_RESTORING = 'RESTORING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains this master encryption key.
-
#current_key_version ⇒ String
[Required] The OCID of the key version used in cryptographic operations.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the key.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the key.
-
#key_shape ⇒ OCI::KeyManagement::Models::KeyShape
This attribute is required.
-
#lifecycle_state ⇒ String
[Required] The key's current lifecycle state.
-
#restored_from_key_id ⇒ String
The OCID of the key from which this key was restored.
-
#time_created ⇒ DateTime
[Required] The date and time the key was created, expressed in RFC 3339 timestamp format.
-
#time_of_deletion ⇒ DateTime
An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format.
-
#vault_id ⇒ String
[Required] The OCID of the vault that contains this key.
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 = {}) ⇒ Key
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 = {}) ⇒ Key
Initializes the object
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 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 |
# File 'lib/oci/key_management/models/key.rb', line 153 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.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.current_key_version = attributes[:'currentKeyVersion'] if attributes[:'currentKeyVersion'] raise 'You cannot provide both :currentKeyVersion and :current_key_version' if attributes.key?(:'currentKeyVersion') && attributes.key?(:'current_key_version') self.current_key_version = attributes[:'current_key_version'] if attributes[:'current_key_version'] 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.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. = 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.id = attributes[:'id'] if attributes[:'id'] self.key_shape = attributes[:'keyShape'] if attributes[:'keyShape'] raise 'You cannot provide both :keyShape and :key_shape' if attributes.key?(:'keyShape') && attributes.key?(:'key_shape') self.key_shape = attributes[:'key_shape'] if attributes[:'key_shape'] 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.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_of_deletion = attributes[:'timeOfDeletion'] if attributes[:'timeOfDeletion'] raise 'You cannot provide both :timeOfDeletion and :time_of_deletion' if attributes.key?(:'timeOfDeletion') && attributes.key?(:'time_of_deletion') self.time_of_deletion = attributes[:'time_of_deletion'] if attributes[:'time_of_deletion'] self.vault_id = attributes[:'vaultId'] if attributes[:'vaultId'] raise 'You cannot provide both :vaultId and :vault_id' if attributes.key?(:'vaultId') && attributes.key?(:'vault_id') self.vault_id = attributes[:'vault_id'] if attributes[:'vault_id'] self.restored_from_key_id = attributes[:'restoredFromKeyId'] if attributes[:'restoredFromKeyId'] raise 'You cannot provide both :restoredFromKeyId and :restored_from_key_id' if attributes.key?(:'restoredFromKeyId') && attributes.key?(:'restored_from_key_id') self.restored_from_key_id = attributes[:'restored_from_key_id'] if attributes[:'restored_from_key_id'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains this master encryption key.
30 31 32 |
# File 'lib/oci/key_management/models/key.rb', line 30 def compartment_id @compartment_id end |
#current_key_version ⇒ String
[Required] The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion
property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
37 38 39 |
# File 'lib/oci/key_management/models/key.rb', line 37 def current_key_version @current_key_version 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\"}}
44 45 46 |
# File 'lib/oci/key_management/models/key.rb', line 44 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
50 51 52 |
# File 'lib/oci/key_management/models/key.rb', line 50 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\"}
57 58 59 |
# File 'lib/oci/key_management/models/key.rb', line 57 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the key.
61 62 63 |
# File 'lib/oci/key_management/models/key.rb', line 61 def id @id end |
#key_shape ⇒ OCI::KeyManagement::Models::KeyShape
This attribute is required.
65 66 67 |
# File 'lib/oci/key_management/models/key.rb', line 65 def key_shape @key_shape end |
#lifecycle_state ⇒ String
[Required] The key's current lifecycle state.
Example: ENABLED
72 73 74 |
# File 'lib/oci/key_management/models/key.rb', line 72 def lifecycle_state @lifecycle_state end |
#restored_from_key_id ⇒ String
The OCID of the key from which this key was restored.
93 94 95 |
# File 'lib/oci/key_management/models/key.rb', line 93 def restored_from_key_id @restored_from_key_id end |
#time_created ⇒ DateTime
[Required] The date and time the key was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z
79 80 81 |
# File 'lib/oci/key_management/models/key.rb', line 79 def time_created @time_created end |
#time_of_deletion ⇒ DateTime
An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
85 86 87 |
# File 'lib/oci/key_management/models/key.rb', line 85 def time_of_deletion @time_of_deletion end |
#vault_id ⇒ String
[Required] The OCID of the vault that contains this key.
89 90 91 |
# File 'lib/oci/key_management/models/key.rb', line 89 def vault_id @vault_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/oci/key_management/models/key.rb', line 96 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'current_key_version': :'currentKeyVersion', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'id': :'id', 'key_shape': :'keyShape', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'time_of_deletion': :'timeOfDeletion', 'vault_id': :'vaultId', 'restored_from_key_id': :'restoredFromKeyId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/oci/key_management/models/key.rb', line 116 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'current_key_version': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'key_shape': :'OCI::KeyManagement::Models::KeyShape', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'time_of_deletion': :'DateTime', 'vault_id': :'String', 'restored_from_key_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/oci/key_management/models/key.rb', line 248 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && current_key_version == other.current_key_version && == other. && display_name == other.display_name && == other. && id == other.id && key_shape == other.key_shape && lifecycle_state == other.lifecycle_state && time_created == other.time_created && time_of_deletion == other.time_of_deletion && vault_id == other.vault_id && restored_from_key_id == other.restored_from_key_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/oci/key_management/models/key.rb', line 289 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
269 270 271 |
# File 'lib/oci/key_management/models/key.rb', line 269 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
278 279 280 |
# File 'lib/oci/key_management/models/key.rb', line 278 def hash [compartment_id, current_key_version, , display_name, , id, key_shape, lifecycle_state, time_created, time_of_deletion, vault_id, restored_from_key_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
322 323 324 325 326 327 328 329 330 331 |
# File 'lib/oci/key_management/models/key.rb', line 322 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
316 317 318 |
# File 'lib/oci/key_management/models/key.rb', line 316 def to_s to_hash.to_s end |