Class: OCI::GoldenGate::Models::UpdateDb2ConnectionDetails

Inherits:
UpdateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/update_db2_connection_details.rb

Overview

The information to update a DB2 Connection.

Constant Summary

Constants inherited from UpdateConnectionDetails

OCI::GoldenGate::Models::UpdateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::UpdateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from UpdateConnectionDetails

#connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #key_id, #nsg_ids, #routing_method, #security_attributes, #subnet_id, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from UpdateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDb2ConnectionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :vault_id (String) —

    The value to assign to the #vault_id proprety

  • :key_id (String) —

    The value to assign to the #key_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :routing_method (String) —

    The value to assign to the #routing_method proprety

  • :does_use_secret_ids (BOOLEAN) —

    The value to assign to the #does_use_secret_ids proprety

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes proprety

  • :database_name (String) —

    The value to assign to the #database_name property

  • :host (String) —

    The value to assign to the #host property

  • :port (Integer) —

    The value to assign to the #port property

  • :username (String) —

    The value to assign to the #username property

  • :password (String) —

    The value to assign to the #password property

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :additional_attributes (Array<OCI::GoldenGate::Models::NameValuePair>) —

    The value to assign to the #additional_attributes property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :ssl_client_keystoredb (String) —

    The value to assign to the #ssl_client_keystoredb property

  • :ssl_client_keystoredb_secret_id (String) —

    The value to assign to the #ssl_client_keystoredb_secret_id property

  • :ssl_client_keystash (String) —

    The value to assign to the #ssl_client_keystash property

  • :ssl_client_keystash_secret_id (String) —

    The value to assign to the #ssl_client_keystash_secret_id property

  • :ssl_server_certificate (String) —

    The value to assign to the #ssl_server_certificate property



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 193

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['connectionType'] = 'DB2'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.database_name = attributes[:'databaseName'] if attributes[:'databaseName']

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

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

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

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

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

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

  self.password_secret_id = attributes[:'passwordSecretId'] if attributes[:'passwordSecretId']

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

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

  self.additional_attributes = attributes[:'additionalAttributes'] if attributes[:'additionalAttributes']

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

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

  self.security_protocol = attributes[:'securityProtocol'] if attributes[:'securityProtocol']

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

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

  self.ssl_client_keystoredb = attributes[:'sslClientKeystoredb'] if attributes[:'sslClientKeystoredb']

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

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

  self.ssl_client_keystoredb_secret_id = attributes[:'sslClientKeystoredbSecretId'] if attributes[:'sslClientKeystoredbSecretId']

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

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

  self.ssl_client_keystash = attributes[:'sslClientKeystash'] if attributes[:'sslClientKeystash']

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

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

  self.ssl_client_keystash_secret_id = attributes[:'sslClientKeystashSecretId'] if attributes[:'sslClientKeystashSecretId']

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

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

  self.ssl_server_certificate = attributes[:'sslServerCertificate'] if attributes[:'sslServerCertificate']

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

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

Instance Attribute Details

#additional_attributes ⇒ Array<OCI::GoldenGate::Models::NameValuePair>

An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:



51
52
53
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 51

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

The name of the database.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 16

def database_name
  @database_name
end

#host ⇒ String

The name or address of a host.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 21

def host
  @host
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated DB2 database. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 38

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated DB2 database. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 45

def password_secret_id
  @password_secret_id
end

#port ⇒ Integer

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 26

def port
  @port
end

#security_protocol ⇒ String

Security protocol for the DB2 database.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 55

def security_protocol
  @security_protocol
end

#ssl_client_keystash ⇒ String

The base64 encoded keystash file which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by "sslClientKeystashSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 80

def ssl_client_keystash
  @ssl_client_keystash
end

#ssl_client_keystash_secret_id ⇒ String

The OCID of the Secret where the keystash file is stored, which contains the encrypted password to the key database file. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystash' field must not be provided.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 89

def ssl_client_keystash_secret_id
  @ssl_client_keystash_secret_id
end

#ssl_client_keystoredb ⇒ String

The base64 encoded keystore file created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Deprecated: This field is deprecated and replaced by "sslClientKeystoredbSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 63

def ssl_client_keystoredb
  @ssl_client_keystoredb
end

#ssl_client_keystoredb_secret_id ⇒ String

The OCID of the Secret where the keystore file stored, which created at the client containing the server certificate / CA root certificate. This property is not supported for IBM Db2 for i, as client TLS mode is not available.

Note: When provided, 'sslClientKeystoredb' field must not be provided.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 72

def ssl_client_keystoredb_secret_id
  @ssl_client_keystoredb_secret_id
end

#ssl_server_certificate ⇒ String

The base64 encoded file which contains the self-signed server certificate / Certificate Authority (CA) certificate. It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 95

def ssl_server_certificate
  @ssl_server_certificate
end

#username ⇒ String

The username Oracle GoldenGate uses to connect to the DB2 database. This username must already exist and be available by the DB2 to be connected to.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 32

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'security_attributes': :'securityAttributes',
    'database_name': :'databaseName',
    'host': :'host',
    'port': :'port',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'additional_attributes': :'additionalAttributes',
    'security_protocol': :'securityProtocol',
    'ssl_client_keystoredb': :'sslClientKeystoredb',
    'ssl_client_keystoredb_secret_id': :'sslClientKeystoredbSecretId',
    'ssl_client_keystash': :'sslClientKeystash',
    'ssl_client_keystash_secret_id': :'sslClientKeystashSecretId',
    'ssl_server_certificate': :'sslServerCertificate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 131

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'vault_id': :'String',
    'key_id': :'String',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'security_attributes': :'Hash<String, Hash<String, Object>>',
    'database_name': :'String',
    'host': :'String',
    'port': :'Integer',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'additional_attributes': :'Array<OCI::GoldenGate::Models::NameValuePair>',
    'security_protocol': :'String',
    'ssl_client_keystoredb': :'String',
    'ssl_client_keystoredb_secret_id': :'String',
    'ssl_client_keystash': :'String',
    'ssl_client_keystash_secret_id': :'String',
    'ssl_server_certificate': :'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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 273

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    security_attributes == other.security_attributes &&
    database_name == other.database_name &&
    host == other.host &&
    port == other.port &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    additional_attributes == other.additional_attributes &&
    security_protocol == other.security_protocol &&
    ssl_client_keystoredb == other.ssl_client_keystoredb &&
    ssl_client_keystoredb_secret_id == other.ssl_client_keystoredb_secret_id &&
    ssl_client_keystash == other.ssl_client_keystash &&
    ssl_client_keystash_secret_id == other.ssl_client_keystash_secret_id &&
    ssl_server_certificate == other.ssl_server_certificate
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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 327

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


307
308
309
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 307

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 316

def hash
  [connection_type, display_name, description, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, does_use_secret_ids, security_attributes, database_name, host, port, username, password, password_secret_id, additional_attributes, security_protocol, ssl_client_keystoredb, ssl_client_keystoredb_secret_id, ssl_client_keystash, ssl_client_keystash_secret_id, ssl_server_certificate].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 360

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



354
355
356
 
# File 'lib/oci/golden_gate/models/update_db2_connection_details.rb', line 354

def to_s
  to_hash.to_s
end