Class: OCI::KeyManagement::Models::ExportKeyDetails
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::ExportKeyDetails
- Defined in:
- lib/oci/key_management/models/export_key_details.rb
Overview
The details of the key that you want to wrap and export.
Constant Summary collapse
- ALGORITHM_ENUM =
[ ALGORITHM_RSA_OAEP_AES_SHA256 = 'RSA_OAEP_AES_SHA256'.freeze, ALGORITHM_RSA_OAEP_SHA256 = 'RSA_OAEP_SHA256'.freeze ].freeze
Instance Attribute Summary collapse
-
#algorithm ⇒ String
[Required] The encryption algorithm to use to encrypt exportable key material from a software-backed key.
-
#key_id ⇒ String
[Required] The OCID of the master encryption key associated with the key version you want to export.
-
#key_version_id ⇒ String
The OCID of the specific key version to export.
-
#logging_context ⇒ Hash<String, String>
Information that provides context for audit logging.
-
#public_key ⇒ String
[Required] The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the 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 = {}) ⇒ ExportKeyDetails
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 = {}) ⇒ ExportKeyDetails
Initializes the object
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 83 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.key_id = attributes[:'keyId'] if attributes[:'keyId'] raise 'You cannot provide both :keyId and :key_id' if attributes.key?(:'keyId') && attributes.key?(:'key_id') self.key_id = attributes[:'key_id'] if attributes[:'key_id'] self.key_version_id = attributes[:'keyVersionId'] if attributes[:'keyVersionId'] raise 'You cannot provide both :keyVersionId and :key_version_id' if attributes.key?(:'keyVersionId') && attributes.key?(:'key_version_id') self.key_version_id = attributes[:'key_version_id'] if attributes[:'key_version_id'] self.algorithm = attributes[:'algorithm'] if attributes[:'algorithm'] self.public_key = attributes[:'publicKey'] if attributes[:'publicKey'] raise 'You cannot provide both :publicKey and :public_key' if attributes.key?(:'publicKey') && attributes.key?(:'public_key') self.public_key = attributes[:'public_key'] if attributes[:'public_key'] self.logging_context = attributes[:'loggingContext'] if attributes[:'loggingContext'] raise 'You cannot provide both :loggingContext and :logging_context' if attributes.key?(:'loggingContext') && attributes.key?(:'logging_context') self.logging_context = attributes[:'logging_context'] if attributes[:'logging_context'] end |
Instance Attribute Details
#algorithm ⇒ String
[Required] The encryption algorithm to use to encrypt exportable key material from a software-backed key. Specifying RSA_OAEP_AES_SHA256
invokes the RSA AES key wrap mechanism, which generates a temporary AES key. The temporary AES key is wrapped by the RSA public wrapping key provided along with the request, creating a wrapped temporary AES key. The temporary AES key is also used to wrap the exportable key material. The wrapped temporary AES key and the wrapped exportable key material are concatenated, producing concatenated blob output that jointly represents them. Specifying RSA_OAEP_SHA256
means that the software key is wrapped by the RSA public wrapping key provided along with the request.
33 34 35 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 33 def algorithm @algorithm end |
#key_id ⇒ String
[Required] The OCID of the master encryption key associated with the key version you want to export.
18 19 20 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 18 def key_id @key_id end |
#key_version_id ⇒ String
The OCID of the specific key version to export. If not specified, the service exports the current key version.
23 24 25 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 23 def key_version_id @key_version_id end |
#logging_context ⇒ Hash<String, String>
Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.
44 45 46 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 44 def logging_context @logging_context end |
#public_key ⇒ String
[Required] The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key in your possession that you want to use to encrypt the key.
38 39 40 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 38 def public_key @public_key end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 47 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key_id': :'keyId', 'key_version_id': :'keyVersionId', 'algorithm': :'algorithm', 'public_key': :'publicKey', 'logging_context': :'loggingContext' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 60 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key_id': :'String', 'key_version_id': :'String', 'algorithm': :'String', 'public_key': :'String', 'logging_context': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 131 def ==(other) return true if equal?(other) self.class == other.class && key_id == other.key_id && key_version_id == other.key_version_id && algorithm == other.algorithm && public_key == other.public_key && logging_context == other.logging_context end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 165 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
145 146 147 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 145 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
154 155 156 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 154 def hash [key_id, key_version_id, algorithm, public_key, logging_context].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
198 199 200 201 202 203 204 205 206 207 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 198 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
192 193 194 |
# File 'lib/oci/key_management/models/export_key_details.rb', line 192 def to_s to_hash.to_s end |