Class: OCI::KeyManagement::Models::EncryptedData
- Inherits:
-
Object
- Object
- OCI::KeyManagement::Models::EncryptedData
- Defined in:
- lib/oci/key_management/models/encrypted_data.rb
Overview
The response to a request to encrypt the plaintext data.
Constant Summary collapse
- ENCRYPTION_ALGORITHM_ENUM =
[ ENCRYPTION_ALGORITHM_AES_256_GCM = 'AES_256_GCM'.freeze, ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = 'RSA_OAEP_SHA_1'.freeze, ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = 'RSA_OAEP_SHA_256'.freeze, ENCRYPTION_ALGORITHM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#ciphertext ⇒ String
[Required] The encrypted data.
-
#encryption_algorithm ⇒ String
The encryption algorithm to use to encrypt and decrypt data with a customer-managed key.
-
#key_id ⇒ String
The OCID of the key used to encrypt the ciphertext.
-
#key_version_id ⇒ String
The OCID of the key version used to encrypt the ciphertext.
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 = {}) ⇒ EncryptedData
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 = {}) ⇒ EncryptedData
Initializes the object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 75 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 |
Instance Attribute Details
#ciphertext ⇒ String
[Required] The encrypted data.
21 22 23 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 21 def ciphertext @ciphertext end |
#encryption_algorithm ⇒ 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.
39 40 41 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 39 def encryption_algorithm @encryption_algorithm end |
#key_id ⇒ String
The OCID of the key used to encrypt the ciphertext.
25 26 27 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 25 def key_id @key_id end |
#key_version_id ⇒ String
The OCID of the key version used to encrypt the ciphertext.
29 30 31 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 29 def key_version_id @key_version_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
42 43 44 45 46 47 48 49 50 51 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 42 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 |
.swagger_types ⇒ Object
Attribute type mapping.
54 55 56 57 58 59 60 61 62 63 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 54 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 |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 124 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 157 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
137 138 139 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 137 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
146 147 148 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 146 def hash [ciphertext, key_id, key_version_id, encryption_algorithm].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
190 191 192 193 194 195 196 197 198 199 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 190 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
184 185 186 |
# File 'lib/oci/key_management/models/encrypted_data.rb', line 184 def to_s to_hash.to_s end |