class OCI::KeyManagement::Models::EncryptedData
EncryptedData
model.
Constants
- ENCRYPTION_ALGORITHM_ENUM
Attributes
[Required] The encrypted data. @return [String]
The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. `AES_256_GCM` indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). `RSA_OAEP_SHA_1` indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). `RSA_OAEP_SHA_256` indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP.
@return [String]
The OCID of the key used to encrypt the ciphertext. @return [String]
The OCID of the key version used to encrypt the ciphertext. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/key_management/models/encrypted_data.rb, line 41 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'ciphertext': :'ciphertext', 'key_id': :'keyId', 'key_version_id': :'keyVersionId', 'encryption_algorithm': :'encryptionAlgorithm' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :ciphertext The value to assign to the {#ciphertext} property @option attributes [String] :key_id The value to assign to the {#key_id} property @option attributes [String] :key_version_id The value to assign to the {#key_version_id} property @option attributes [String] :encryption_algorithm The value to assign to the {#encryption_algorithm} property
# File lib/oci/key_management/models/encrypted_data.rb, line 74 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.ciphertext = attributes[:'ciphertext'] if attributes[:'ciphertext'] 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.encryption_algorithm = attributes[:'encryptionAlgorithm'] if attributes[:'encryptionAlgorithm'] self.encryption_algorithm = "AES_256_GCM" if encryption_algorithm.nil? && !attributes.key?(:'encryptionAlgorithm') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :encryptionAlgorithm and :encryption_algorithm' if attributes.key?(:'encryptionAlgorithm') && attributes.key?(:'encryption_algorithm') self.encryption_algorithm = attributes[:'encryption_algorithm'] if attributes[:'encryption_algorithm'] self.encryption_algorithm = "AES_256_GCM" if encryption_algorithm.nil? && !attributes.key?(:'encryptionAlgorithm') && !attributes.key?(:'encryption_algorithm') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/key_management/models/encrypted_data.rb, line 53 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'ciphertext': :'String', 'key_id': :'String', 'key_version_id': :'String', 'encryption_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/encrypted_data.rb, line 123 def ==(other) return true if equal?(other) self.class == other.class && ciphertext == other.ciphertext && key_id == other.key_id && key_version_id == other.key_version_id && encryption_algorithm == other.encryption_algorithm 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/encrypted_data.rb, line 156 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
Custom attribute writer method checking allowed values (enum). @param [Object] encryption_algorithm
Object
to be assigned
# File lib/oci/key_management/models/encrypted_data.rb, line 107 def encryption_algorithm=(encryption_algorithm) # rubocop:disable Style/ConditionalAssignment if encryption_algorithm && !ENCRYPTION_ALGORITHM_ENUM.include?(encryption_algorithm) OCI.logger.debug("Unknown value for 'encryption_algorithm' [" + encryption_algorithm + "]. Mapping to 'ENCRYPTION_ALGORITHM_UNKNOWN_ENUM_VALUE'") if OCI.logger @encryption_algorithm = ENCRYPTION_ALGORITHM_UNKNOWN_ENUM_VALUE else @encryption_algorithm = encryption_algorithm end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/key_management/models/encrypted_data.rb, line 136 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/key_management/models/encrypted_data.rb, line 145 def hash [ciphertext, key_id, key_version_id, encryption_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/encrypted_data.rb, line 189 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/encrypted_data.rb, line 183 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/encrypted_data.rb, line 206 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