class OCI::KeyManagement::Models::ExportedKeyData
The response to a request to export key material.
Constants
- ALGORITHM_ENUM
Attributes
[Required] The encryption algorithm to use to encrypt exportable key material from a key that persists on the server (as opposed to a key that persists on a hardware security module and, therefore, cannot be exported). 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 exportable key material is wrapped by the RSA public wrapping key provided along with the request.
@return [String]
[Required] The base64-encoded exported key material, which is encrypted by using the public RSA wrapping key specified in the export request.
@return [String]
[Required] The OCID of the master encryption key associated with this key version. @return [String]
[Required] The OCID of the key version. @return [String]
[Required] The date and time this key version was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format.
@return [DateTime]
[Required] The OCID of the vault that contains this key version. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/key_management/models/exported_key_data.rb, line 51 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'key_version_id': :'keyVersionId', 'key_id': :'keyId', 'time_created': :'timeCreated', 'vault_id': :'vaultId', 'encrypted_key': :'encryptedKey', 'algorithm': :'algorithm' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :key_version_id The value to assign to the {#key_version_id} property @option attributes [String] :key_id The value to assign to the {#key_id} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :vault_id The value to assign to the {#vault_id} property @option attributes [String] :encrypted_key The value to assign to the {#encrypted_key} property @option attributes [String] :algorithm The value to assign to the {#algorithm} property
# File lib/oci/key_management/models/exported_key_data.rb, line 90 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_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.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.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.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.encrypted_key = attributes[:'encryptedKey'] if attributes[:'encryptedKey'] raise 'You cannot provide both :encryptedKey and :encrypted_key' if attributes.key?(:'encryptedKey') && attributes.key?(:'encrypted_key') self.encrypted_key = attributes[:'encrypted_key'] if attributes[:'encrypted_key'] self.algorithm = attributes[:'algorithm'] if attributes[:'algorithm'] end
Attribute type mapping.
# File lib/oci/key_management/models/exported_key_data.rb, line 65 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'key_version_id': :'String', 'key_id': :'String', 'time_created': :'DateTime', 'vault_id': :'String', 'encrypted_key': :'String', 'algorithm': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/key_management/models/exported_key_data.rb, line 149 def ==(other) return true if equal?(other) self.class == other.class && key_version_id == other.key_version_id && key_id == other.key_id && time_created == other.time_created && vault_id == other.vault_id && encrypted_key == other.encrypted_key && algorithm == other.algorithm end
Custom attribute writer method checking allowed values (enum). @param [Object] algorithm Object
to be assigned
# File lib/oci/key_management/models/exported_key_data.rb, line 133 def algorithm=(algorithm) # rubocop:disable Style/ConditionalAssignment if algorithm && !ALGORITHM_ENUM.include?(algorithm) OCI.logger.debug("Unknown value for 'algorithm' [" + algorithm + "]. Mapping to 'ALGORITHM_UNKNOWN_ENUM_VALUE'") if OCI.logger @algorithm = ALGORITHM_UNKNOWN_ENUM_VALUE else @algorithm = algorithm end # rubocop:enable Style/ConditionalAssignment end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/key_management/models/exported_key_data.rb, line 184 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/key_management/models/exported_key_data.rb, line 164 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/key_management/models/exported_key_data.rb, line 173 def hash [key_version_id, key_id, time_created, vault_id, encrypted_key, algorithm].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/key_management/models/exported_key_data.rb, line 217 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/key_management/models/exported_key_data.rb, line 211 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/key_management/models/exported_key_data.rb, line 234 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end