Class: OCI::GoldenGate::Models::CreateMysqlConnectionDetails

Inherits:
CreateConnectionDetails show all
Defined in:
lib/oci/golden_gate/models/create_mysql_connection_details.rb

Overview

The information about a new MySQL Connection.

Constant Summary

Constants inherited from CreateConnectionDetails

OCI::GoldenGate::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::CreateConnectionDetails::ROUTING_METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateConnectionDetails

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateConnectionDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateMysqlConnectionDetails

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

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

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

  • :technology_type (String)

    The value to assign to the #technology_type property

  • :username (String)

    The value to assign to the #username property

  • :password (String)

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

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



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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 198

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

  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.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_attributesArray<OCI::GoldenGate::Models::NameValuePair>

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



92
93
94
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 92

def additional_attributes
  @additional_attributes
end

#database_nameString

[Required] The name of the database.

Returns:

  • (String)


43
44
45
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 43

def database_name
  @database_name
end

#db_system_idString

The OCID of the database system being referenced.

Returns:

  • (String)


97
98
99
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 97

def db_system_id
  @db_system_id
end

#hostString

The name or address of a host.

Returns:

  • (String)


33
34
35
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 33

def host
  @host
end

#passwordString

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

Returns:

  • (String)


28
29
30
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 28

def password
  @password
end

#portInteger

The port of an endpoint usually specified for a connection.

Returns:

  • (Integer)


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

def port
  @port
end

#private_ipString

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)


86
87
88
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 86

def private_ip
  @private_ip
end

#security_protocolString

[Required] Security Type for MySQL.

Returns:

  • (String)


47
48
49
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 47

def security_protocol
  @security_protocol
end

#ssl_caString

Database Certificate - The base64 encoded content of a .pem or .crt file. containing the server public key (for 1 and 2-way SSL).

Returns:

  • (String)


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

def ssl_ca
  @ssl_ca
end

#ssl_certString

Client Certificate - The base64 encoded content of a .pem or .crt file. containing the client public key (for 2-way SSL).

Returns:

  • (String)


69
70
71
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 69

def ssl_cert
  @ssl_cert
end

#ssl_crlString

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.

Returns:

  • (String)


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

def ssl_crl
  @ssl_crl
end

#ssl_keyString

Client Key u2013 The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).

Returns:

  • (String)


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

def ssl_key
  @ssl_key
end

#ssl_modeString

SSL modes for MySQL.

Returns:

  • (String)


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

def ssl_mode
  @ssl_mode
end

#technology_typeString

[Required] The MySQL technology type.

Returns:

  • (String)


15
16
17
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 15

def technology_type
  @technology_type
end

#usernameString

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


22
23
24
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 22

def username
  @username
end

Class Method Details

.attribute_mapObject

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



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
129
130
131
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 100

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'connectionType',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'vault_id': :'vaultId',
    'key_id': :'keyId',
    'nsg_ids': :'nsgIds',
    'subnet_id': :'subnetId',
    'routing_method': :'routingMethod',
    'technology_type': :'technologyType',
    'username': :'username',
    'password': :'password',
    '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',
    'private_ip': :'privateIp',
    'additional_attributes': :'additionalAttributes',
    'db_system_id': :'dbSystemId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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
162
163
164
165
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 134

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'connection_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'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',
    'technology_type': :'String',
    'username': :'String',
    'password': :'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',
    '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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 290

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

  self.class == other.class &&
    connection_type == other.connection_type &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    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 &&
    technology_type == other.technology_type &&
    username == other.username &&
    password == other.password &&
    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 &&
    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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 345

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


325
326
327
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 325

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



334
335
336
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 334

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, vault_id, key_id, nsg_ids, subnet_id, routing_method, technology_type, username, password, host, port, database_name, security_protocol, ssl_mode, ssl_ca, ssl_crl, ssl_cert, ssl_key, private_ip, additional_attributes, db_system_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



378
379
380
381
382
383
384
385
386
387
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 378

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



372
373
374
# File 'lib/oci/golden_gate/models/create_mysql_connection_details.rb', line 372

def to_s
  to_hash.to_s
end