Class: OCI::GoldenGate::Models::MysqlConnection

Inherits:
Connection
  • Object
show all
Defined in:
lib/oci/golden_gate/models/mysql_connection.rb

Overview

Represents the metadata of a MySQL Connection.

Constant Summary collapse

TECHNOLOGY_TYPE_ENUM = 
[
  TECHNOLOGY_TYPE_AMAZON_AURORA_MYSQL = 'AMAZON_AURORA_MYSQL'.freeze,
  TECHNOLOGY_TYPE_AMAZON_RDS_MARIADB = 'AMAZON_RDS_MARIADB'.freeze,
  TECHNOLOGY_TYPE_AMAZON_RDS_MYSQL = 'AMAZON_RDS_MYSQL'.freeze,
  TECHNOLOGY_TYPE_AZURE_MYSQL = 'AZURE_MYSQL'.freeze,
  TECHNOLOGY_TYPE_GOOGLE_CLOUD_SQL_MYSQL = 'GOOGLE_CLOUD_SQL_MYSQL'.freeze,
  TECHNOLOGY_TYPE_MARIADB = 'MARIADB'.freeze,
  TECHNOLOGY_TYPE_MYSQL_HEATWAVE_ON_AZURE = 'MYSQL_HEATWAVE_ON_AZURE'.freeze,
  TECHNOLOGY_TYPE_MYSQL_HEATWAVE_ON_AWS = 'MYSQL_HEATWAVE_ON_AWS'.freeze,
  TECHNOLOGY_TYPE_MYSQL_SERVER = 'MYSQL_SERVER'.freeze,
  TECHNOLOGY_TYPE_OCI_MYSQL = 'OCI_MYSQL'.freeze,
  TECHNOLOGY_TYPE_SINGLESTOREDB = 'SINGLESTOREDB'.freeze,
  TECHNOLOGY_TYPE_SINGLESTOREDB_CLOUD = 'SINGLESTOREDB_CLOUD'.freeze,
  TECHNOLOGY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_PROTOCOL_ENUM = 
[
  SECURITY_PROTOCOL_PLAIN = 'PLAIN'.freeze,
  SECURITY_PROTOCOL_TLS = 'TLS'.freeze,
  SECURITY_PROTOCOL_MTLS = 'MTLS'.freeze,
  SECURITY_PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SSL_MODE_ENUM = 
[
  SSL_MODE_DISABLED = 'DISABLED'.freeze,
  SSL_MODE_PREFERRED = 'PREFERRED'.freeze,
  SSL_MODE_REQUIRED = 'REQUIRED'.freeze,
  SSL_MODE_VERIFY_CA = 'VERIFY_CA'.freeze,
  SSL_MODE_VERIFY_IDENTITY = 'VERIFY_IDENTITY'.freeze,
  SSL_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Connection

Connection::CONNECTION_TYPE_ENUM, Connection::LIFECYCLE_STATE_ENUM, Connection::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from Connection

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #does_use_secret_ids, #freeform_tags, #id, #ingress_ips, #key_id, #lifecycle_details, #lifecycle_state, #locks, #nsg_ids, #routing_method, #subnet_id, #system_tags, #time_created, #time_updated, #vault_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Connection

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ MysqlConnection

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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

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

    The value to assign to the #system_tags proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :locks (Array<OCI::GoldenGate::Models::ResourceLock>) —

    The value to assign to the #locks 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

  • :ingress_ips (Array<OCI::GoldenGate::Models::IngressIpDetails>) —

    The value to assign to the #ingress_ips 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

  • :technology_type (String) —

    The value to assign to the #technology_type property

  • :username (String) —

    The value to assign to the #username 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

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

  • :password_secret_id (String) —

    The value to assign to the #password_secret_id property

  • :ssl_key_secret_id (String) —

    The value to assign to the #ssl_key_secret_id property



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/mysql_connection.rb', line 236

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

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

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

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

  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.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']

  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.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']
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:



96
97
98
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 96

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

The name of the database.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 70

def database_name
  @database_name
end

#db_system_id ⇒ String

The OCID of the database system being referenced.

Returns:

  • (String) 


101
102
103
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 101

def db_system_id
  @db_system_id
end

#host ⇒ String

The name or address of a host.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 60

def host
  @host
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) 


110
111
112
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 110

def password_secret_id
  @password_secret_id
end

#port ⇒ Integer

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 65

def port
  @port
end

#private_ip ⇒ String

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 90

def private_ip
  @private_ip
end

#security_protocol ⇒ String

[Required] Security Protocol for MySQL.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 74

def security_protocol
  @security_protocol
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) 


117
118
119
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 117

def ssl_key_secret_id
  @ssl_key_secret_id
end

#ssl_mode ⇒ String

SSL modes for MySQL.

Returns:

  • (String) 


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

def ssl_mode
  @ssl_mode
end

#technology_type ⇒ String

[Required] The MySQL technology type.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 48

def technology_type
  @technology_type
end

#username ⇒ String

[Required] 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) 


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

def username
  @username
end

Class Method Details

.attribute_map ⇒ Object

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



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
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 120

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'locks': :'locks',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'ingress_ips': :'ingressIps',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'does_use_secret_ids': :'doesUseSecretIds',
    'technology_type': :'technologyType',
    'username': :'username',
    'host': :'host',
    'port': :'port',
    'database_name': :'databaseName',
    'security_protocol': :'securityProtocol',
    'ssl_mode': :'sslMode',
    'private_ip': :'privateIp',
    'additional_attributes': :'additionalAttributes',
    'db_system_id': :'dbSystemId',
    'password_secret_id': :'passwordSecretId',
    'ssl_key_secret_id': :'sslKeySecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 160

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'locks': :'Array<OCI::GoldenGate::Models::ResourceLock>',
    'vault_id': :'String',
    'key_id': :'String',
    'ingress_ips': :'Array<OCI::GoldenGate::Models::IngressIpDetails>',
    'nsg_ids': :'Array<String>',
    'subnet_id': :'String',
    'routing_method': :'String',
    'does_use_secret_ids': :'BOOLEAN',
    'technology_type': :'String',
    'username': :'String',
    'host': :'String',
    'port': :'Integer',
    'database_name': :'String',
    'security_protocol': :'String',
    'ssl_mode': :'String',
    'private_ip': :'String',
    'additional_attributes': :'Array<OCI::GoldenGate::Models::NameValuePair>',
    'db_system_id': :'String',
    'password_secret_id': :'String',
    'ssl_key_secret_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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 353

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    locks == other.locks &&
    vault_id == other.vault_id &&
    key_id == other.key_id &&
    ingress_ips == other.ingress_ips &&
    nsg_ids == other.nsg_ids &&
    subnet_id == other.subnet_id &&
    routing_method == other.routing_method &&
    does_use_secret_ids == other.does_use_secret_ids &&
    technology_type == other.technology_type &&
    username == other.username &&
    host == other.host &&
    port == other.port &&
    database_name == other.database_name &&
    security_protocol == other.security_protocol &&
    ssl_mode == other.ssl_mode &&
    private_ip == other.private_ip &&
    additional_attributes == other.additional_attributes &&
    db_system_id == other.db_system_id &&
    password_secret_id == other.password_secret_id &&
    ssl_key_secret_id == other.ssl_key_secret_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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 414

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


394
395
396
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 394

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



403
404
405
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 403

def hash
  [connection_type, id, display_name, description, compartment_id, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, locks, vault_id, key_id, ingress_ips, nsg_ids, subnet_id, routing_method, does_use_secret_ids, technology_type, username, host, port, database_name, security_protocol, ssl_mode, private_ip, additional_attributes, db_system_id, password_secret_id, ssl_key_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 447

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



441
442
443
 
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 441

def to_s
  to_hash.to_s
end