Class: OCI::Database::Models::MigrateVaultKeyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/migrate_vault_key_details.rb

Overview

Details for replacing existing Oracle-managed keys with customer-managed Vault service keys and vice-versa is not supported.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MigrateVaultKeyDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :kms_key_id (String) —

    The value to assign to the #kms_key_id property

  • :kms_key_version_id (String) —

    The value to assign to the #kms_key_version_id property

  • :vault_id (String) —

    The value to assign to the #vault_id property

  • :tde_wallet_password (String) —

    The value to assign to the #tde_wallet_password property

  • :admin_password (String) —

    The value to assign to the #admin_password property



70
71
72
73
74
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
103
104
105
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 70

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.kms_key_id = attributes[:'kmsKeyId'] if attributes[:'kmsKeyId']

  raise 'You cannot provide both :kmsKeyId and :kms_key_id' if attributes.key?(:'kmsKeyId') && attributes.key?(:'kms_key_id')

  self.kms_key_id = attributes[:'kms_key_id'] if attributes[:'kms_key_id']

  self.kms_key_version_id = attributes[:'kmsKeyVersionId'] if attributes[:'kmsKeyVersionId']

  raise 'You cannot provide both :kmsKeyVersionId and :kms_key_version_id' if attributes.key?(:'kmsKeyVersionId') && attributes.key?(:'kms_key_version_id')

  self.kms_key_version_id = attributes[:'kms_key_version_id'] if attributes[:'kms_key_version_id']

  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.tde_wallet_password = attributes[:'tdeWalletPassword'] if attributes[:'tdeWalletPassword']

  raise 'You cannot provide both :tdeWalletPassword and :tde_wallet_password' if attributes.key?(:'tdeWalletPassword') && attributes.key?(:'tde_wallet_password')

  self.tde_wallet_password = attributes[:'tde_wallet_password'] if attributes[:'tde_wallet_password']

  self.admin_password = attributes[:'adminPassword'] if attributes[:'adminPassword']

  raise 'You cannot provide both :adminPassword and :admin_password' if attributes.key?(:'adminPassword') && attributes.key?(:'admin_password')

  self.admin_password = attributes[:'admin_password'] if attributes[:'admin_password']
end

Instance Attribute Details

#admin_password ⇒ String

The existing admin password of the database.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 31

def admin_password
  @admin_password
end

#kms_key_id ⇒ String

[Required] The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 14

def kms_key_id
  @kms_key_id
end

#kms_key_version_id ⇒ String

The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 19

def kms_key_version_id
  @kms_key_version_id
end

#tde_wallet_password ⇒ String

The existing TDE wallet password of the database.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 27

def tde_wallet_password
  @tde_wallet_password
end

#vault_id ⇒ String

The OCID of the Oracle Cloud Infrastructure vault. This parameter and secretId are required for Customer Managed Keys.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 23

def vault_id
  @vault_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kms_key_id': :'kmsKeyId',
    'kms_key_version_id': :'kmsKeyVersionId',
    'vault_id': :'vaultId',
    'tde_wallet_password': :'tdeWalletPassword',
    'admin_password': :'adminPassword'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kms_key_id': :'String',
    'kms_key_version_id': :'String',
    'vault_id': :'String',
    'tde_wallet_password': :'String',
    'admin_password': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 114

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    kms_key_id == other.kms_key_id &&
    kms_key_version_id == other.kms_key_version_id &&
    vault_id == other.vault_id &&
    tde_wallet_password == other.tde_wallet_password &&
    admin_password == other.admin_password
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 148

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 137

def hash
  [kms_key_id, kms_key_version_id, vault_id, tde_wallet_password, admin_password].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 181

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

Returns:

  • (String) —

    String presentation of the object



175
176
177
 
# File 'lib/oci/database/models/migrate_vault_key_details.rb', line 175

def to_s
  to_hash.to_s
end