Class: OCI::KeyManagement::Models::ImportKeyDetails
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::ImportKeyDetails
- Defined in:
- lib/oci/key_management/models/import_key_details.rb
Overview
The details of the Key that you wish to import.
Constant Summary collapse
- PROTECTION_MODE_ENUM =
[ PROTECTION_MODE_HSM = 'HSM'.freeze, PROTECTION_MODE_SOFTWARE = 'SOFTWARE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains this key.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys.
-
#display_name ⇒ String
[Required] A user-friendly name for the key.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope.
-
#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.
-
#wrapped_import_key ⇒ OCI::KeyManagement::Models::WrappedImportKey
This attribute is required.
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 = {}) ⇒ ImportKeyDetails
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 = {}) ⇒ ImportKeyDetails
Initializes the object
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 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 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 99 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.wrapped_import_key = attributes[:'wrappedImportKey'] if attributes[:'wrappedImportKey'] raise 'You cannot provide both :wrappedImportKey and :wrapped_import_key' if attributes.key?(:'wrappedImportKey') && attributes.key?(:'wrapped_import_key') self.wrapped_import_key = attributes[:'wrapped_import_key'] if attributes[:'wrapped_import_key'] self.protection_mode = attributes[:'protectionMode'] if attributes[:'protectionMode'] self.protection_mode = "HSM" if protection_mode.nil? && !attributes.key?(:'protectionMode') # rubocop:disable Style/StringLiterals 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.protection_mode = "HSM" if protection_mode.nil? && !attributes.key?(:'protectionMode') && !attributes.key?(:'protection_mode') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains this key.
18 19 20 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 18 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"foo-value\"}}
24 25 26 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 24 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.
30 31 32 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 30 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
37 38 39 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 37 def @freeform_tags end |
#key_shape ⇒ OCI::KeyManagement::Models::KeyShape
This attribute is required.
41 42 43 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 41 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.
54 55 56 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 54 def protection_mode @protection_mode end |
#wrapped_import_key ⇒ OCI::KeyManagement::Models::WrappedImportKey
This attribute is required.
45 46 47 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 45 def wrapped_import_key @wrapped_import_key end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 57 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'freeform_tags': :'freeformTags', 'key_shape': :'keyShape', 'wrapped_import_key': :'wrappedImportKey', 'protection_mode': :'protectionMode' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 72 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', 'wrapped_import_key': :'OCI::KeyManagement::Models::WrappedImportKey', 'protection_mode': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 165 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 && wrapped_import_key == other.wrapped_import_key && protection_mode == other.protection_mode end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 201 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
181 182 183 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 181 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
190 191 192 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 190 def hash [compartment_id, , display_name, , key_shape, wrapped_import_key, protection_mode].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
234 235 236 237 238 239 240 241 242 243 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 234 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
228 229 230 |
# File 'lib/oci/key_management/models/import_key_details.rb', line 228 def to_s to_hash.to_s end |