Class: OCI::KeyManagement::Models::CreateKeyDetails
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::CreateKeyDetails
- Defined in:
- lib/oci/key_management/models/create_key_details.rb
Overview
The details of the key that you want to create.
Constant Summary collapse
- PROTECTION_MODE_ENUM =
[ PROTECTION_MODE_HSM = 'HSM'.freeze, PROTECTION_MODE_SOFTWARE = 'SOFTWARE'.freeze, PROTECTION_MODE_EXTERNAL = 'EXTERNAL'.freeze ].freeze
Instance Attribute Summary collapse
- #auto_key_rotation_details ⇒ OCI::KeyManagement::Models::AutoKeyRotationDetails
-
#compartment_id ⇒ String
[Required] The OCID of the compartment where you want to create the master encryption key.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the key.
- #external_key_reference ⇒ OCI::KeyManagement::Models::ExternalKeyReference
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#is_auto_rotation_enabled ⇒ BOOLEAN
A parameter specifying whether the auto key rotation is enabled or not.
-
#key_shape ⇒ OCI::KeyManagement::Models::KeyShape
This attribute is required.
-
#protection_mode ⇒ String
The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
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 = {}) ⇒ CreateKeyDetails
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 = {}) ⇒ CreateKeyDetails
Initializes the object
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 116 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. = 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.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.is_auto_rotation_enabled = attributes[:'isAutoRotationEnabled'] unless attributes[:'isAutoRotationEnabled'].nil? raise 'You cannot provide both :isAutoRotationEnabled and :is_auto_rotation_enabled' if attributes.key?(:'isAutoRotationEnabled') && attributes.key?(:'is_auto_rotation_enabled') self.is_auto_rotation_enabled = attributes[:'is_auto_rotation_enabled'] unless attributes[:'is_auto_rotation_enabled'].nil? self.auto_key_rotation_details = attributes[:'autoKeyRotationDetails'] if attributes[:'autoKeyRotationDetails'] raise 'You cannot provide both :autoKeyRotationDetails and :auto_key_rotation_details' if attributes.key?(:'autoKeyRotationDetails') && attributes.key?(:'auto_key_rotation_details') self.auto_key_rotation_details = attributes[:'auto_key_rotation_details'] if attributes[:'auto_key_rotation_details'] self.protection_mode = attributes[:'protectionMode'] if attributes[:'protectionMode'] raise 'You cannot provide both :protectionMode and :protection_mode' if attributes.key?(:'protectionMode') && attributes.key?(:'protection_mode') self.protection_mode = attributes[:'protection_mode'] if attributes[:'protection_mode'] self.external_key_reference = attributes[:'externalKeyReference'] if attributes[:'externalKeyReference'] raise 'You cannot provide both :externalKeyReference and :external_key_reference' if attributes.key?(:'externalKeyReference') && attributes.key?(:'external_key_reference') self.external_key_reference = attributes[:'external_key_reference'] if attributes[:'external_key_reference'] end |
Instance Attribute Details
#auto_key_rotation_details ⇒ OCI::KeyManagement::Models::AutoKeyRotationDetails
50 51 52 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 50 def auto_key_rotation_details @auto_key_rotation_details end |
#compartment_id ⇒ String
[Required] The OCID of the compartment where you want to create the master encryption key.
19 20 21 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 19 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\"}}
26 27 28 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 26 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.
32 33 34 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 32 def display_name @display_name end |
#external_key_reference ⇒ OCI::KeyManagement::Models::ExternalKeyReference
65 66 67 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 65 def external_key_reference @external_key_reference 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\"}
39 40 41 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 39 def @freeform_tags end |
#is_auto_rotation_enabled ⇒ BOOLEAN
A parameter specifying whether the auto key rotation is enabled or not.
47 48 49 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 47 def is_auto_rotation_enabled @is_auto_rotation_enabled end |
#key_shape ⇒ OCI::KeyManagement::Models::KeyShape
This attribute is required.
43 44 45 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 43 def key_shape @key_shape end |
#protection_mode ⇒ String
The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM
means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE
means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE
are performed on the server. By default, a key's protection mode is set to HSM
. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL
mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL
are performed by external key manager.
62 63 64 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 62 def protection_mode @protection_mode end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 68 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'key_shape': :'keyShape', 'is_auto_rotation_enabled': :'isAutoRotationEnabled', 'auto_key_rotation_details': :'autoKeyRotationDetails', 'protection_mode': :'protectionMode', 'external_key_reference': :'externalKeyReference' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 85 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'freeform_tags': :'Hash<String, String>', 'key_shape': :'OCI::KeyManagement::Models::KeyShape', 'is_auto_rotation_enabled': :'BOOLEAN', 'auto_key_rotation_details': :'OCI::KeyManagement::Models::AutoKeyRotationDetails', 'protection_mode': :'String', 'external_key_reference': :'OCI::KeyManagement::Models::ExternalKeyReference' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 192 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && == other. && key_shape == other.key_shape && is_auto_rotation_enabled == other.is_auto_rotation_enabled && auto_key_rotation_details == other.auto_key_rotation_details && protection_mode == other.protection_mode && external_key_reference == other.external_key_reference end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 230 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
210 211 212 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 210 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
219 220 221 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 219 def hash [compartment_id, , display_name, , key_shape, is_auto_rotation_enabled, auto_key_rotation_details, protection_mode, external_key_reference].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
263 264 265 266 267 268 269 270 271 272 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 263 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
257 258 259 |
# File 'lib/oci/key_management/models/create_key_details.rb', line 257 def to_s to_hash.to_s end |