Class: OCI::GoldenGate::Models::UpdateMysqlConnectionDetails

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

Overview

The information to update a MySQL 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 = {}) ⇒ UpdateMysqlConnectionDetails

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

  • :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

  • :host (String) —

    The value to assign to the #host property

  • :port (Integer) —

    The value to assign to the #port property

  • :database_name (String) —

    The value to assign to the #database_name property

  • :security_protocol (String) —

    The value to assign to the #security_protocol property

  • :ssl_mode (String) —

    The value to assign to the #ssl_mode property

  • :ssl_ca (String) —

    The value to assign to the #ssl_ca property

  • :ssl_crl (String) —

    The value to assign to the #ssl_crl property

  • :ssl_cert (String) —

    The value to assign to the #ssl_cert property

  • :ssl_key (String) —

    The value to assign to the #ssl_key property

  • :ssl_key_secret_id (String) —

    The value to assign to the #ssl_key_secret_id property

  • :private_ip (String) —

    The value to assign to the #private_ip property

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

    The value to assign to the #additional_attributes property

  • :db_system_id (String) —

    The value to assign to the #db_system_id property



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
265
266
267
268
269
270
271
272
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
303
304
305
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 216

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

  attributes['connectionType'] = 'MYSQL'

  super(attributes)

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

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

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

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

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

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

  self.ssl_ca = attributes[:'sslCa'] if attributes[:'sslCa']

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

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

  self.ssl_crl = attributes[:'sslCrl'] if attributes[:'sslCrl']

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

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

  self.ssl_cert = attributes[:'sslCert'] if attributes[:'sslCert']

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

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

  self.ssl_key = attributes[:'sslKey'] if attributes[:'sslKey']

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

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

  self.ssl_key_secret_id = attributes[:'sslKeySecretId'] if attributes[:'sslKeySecretId']

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

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

  self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp']

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

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

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

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

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



104
105
106
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 104

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

The name of the database.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 49

def database_name
  @database_name
end

#db_system_id ⇒ String

The OCID of the database system being referenced.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 109

def db_system_id
  @db_system_id
end

#host ⇒ String

The name or address of a host.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 39

def host
  @host
end

#password ⇒ String

The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 25

def password
  @password
end

#password_secret_id ⇒ String

The OCID of the Secret where the password is stored. The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on. If secretId is used plaintext field must not be provided. Note: When provided, 'password' field must not be provided.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 34

def password_secret_id
  @password_secret_id
end

#port ⇒ Integer

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 44

def port
  @port
end

#private_ip ⇒ String

This property is not available when creating connections. For existing deprecated connections having this value set, the value cannot be updated; set it to empty.

For deprecated connections created with this field in the past, either the private IP had to be specified in the connectionString or host field, or the host name had to be resolvable in the target VCN.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 98

def private_ip
  @private_ip
end

#security_protocol ⇒ String

Security Type for MySQL.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 53

def security_protocol
  @security_protocol
end

#ssl_ca ⇒ String

Database Certificate - The base64 encoded content of a .pem or .crt file containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 64

def ssl_ca
  @ssl_ca
end

#ssl_cert ⇒ String

Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL). It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 78

def ssl_cert
  @ssl_cert
end

#ssl_crl ⇒ String

The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA). Note: This is an optional property and only applicable if TLS/MTLS option is selected. It is not included in GET responses if the view=COMPACT query parameter is specified.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 71

def ssl_crl
  @ssl_crl
end

#ssl_key ⇒ String

Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "sslKeySecretId". This field will be removed after February 15 2026.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 84

def ssl_key
  @ssl_key
end

#ssl_key_secret_id ⇒ String

The OCID of the Secret that stores the Client Key - The content of a .pem or .crt file containing the client private key (for 2-way SSL). Note: When provided, 'sslKey' field must not be provided.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 91

def ssl_key_secret_id
  @ssl_key_secret_id
end

#ssl_mode ⇒ String

SSL modes for MySQL.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 57

def ssl_mode
  @ssl_mode
end

#username ⇒ String

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 18

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 112

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',
    'username': :'username',
    'password': :'password',
    'password_secret_id': :'passwordSecretId',
    'host': :'host',
    'port': :'port',
    'database_name': :'databaseName',
    'security_protocol': :'securityProtocol',
    'ssl_mode': :'sslMode',
    'ssl_ca': :'sslCa',
    'ssl_crl': :'sslCrl',
    'ssl_cert': :'sslCert',
    'ssl_key': :'sslKey',
    'ssl_key_secret_id': :'sslKeySecretId',
    'private_ip': :'privateIp',
    'additional_attributes': :'additionalAttributes',
    'db_system_id': :'dbSystemId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 148

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>>',
    'username': :'String',
    'password': :'String',
    'password_secret_id': :'String',
    'host': :'String',
    'port': :'Integer',
    'database_name': :'String',
    'security_protocol': :'String',
    'ssl_mode': :'String',
    'ssl_ca': :'String',
    'ssl_crl': :'String',
    'ssl_cert': :'String',
    'ssl_key': :'String',
    'ssl_key_secret_id': :'String',
    'private_ip': :'String',
    'additional_attributes': :'Array<OCI::GoldenGate::Models::NameValuePair>',
    'db_system_id': :'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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 314

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 &&
    username == other.username &&
    password == other.password &&
    password_secret_id == other.password_secret_id &&
    host == other.host &&
    port == other.port &&
    database_name == other.database_name &&
    security_protocol == other.security_protocol &&
    ssl_mode == other.ssl_mode &&
    ssl_ca == other.ssl_ca &&
    ssl_crl == other.ssl_crl &&
    ssl_cert == other.ssl_cert &&
    ssl_key == other.ssl_key &&
    ssl_key_secret_id == other.ssl_key_secret_id &&
    private_ip == other.private_ip &&
    additional_attributes == other.additional_attributes &&
    db_system_id == other.db_system_id
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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 371

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


351
352
353
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 351

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



360
361
362
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 360

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, username, password, password_secret_id, host, port, database_name, security_protocol, ssl_mode, ssl_ca, ssl_crl, ssl_cert, ssl_key, ssl_key_secret_id, private_ip, additional_attributes, db_system_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



404
405
406
407
408
409
410
411
412
413
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 404

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



398
399
400
 
# File 'lib/oci/golden_gate/models/update_mysql_connection_details.rb', line 398

def to_s
  to_hash.to_s
end