Class: OCI::DatabaseMigration::Models::CreateMysqlConnectionDetails

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

Overview

The information about a new MySQL Connection.

Constant Summary

Constants inherited from CreateConnectionDetails

OCI::DatabaseMigration::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateConnectionDetails

#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #password, #replication_password, #replication_username, #subnet_id, #username, #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

  • :subnet_id (String) —

    The value to assign to the #subnet_id proprety

  • :nsg_ids (Array<String>) —

    The value to assign to the #nsg_ids proprety

  • :username (String) —

    The value to assign to the #username proprety

  • :password (String) —

    The value to assign to the #password proprety

  • :replication_username (String) —

    The value to assign to the #replication_username proprety

  • :replication_password (String) —

    The value to assign to the #replication_password proprety

  • :technology_type (String) —

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

  • :additional_attributes (Array<OCI::DatabaseMigration::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



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
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
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 169

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.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.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::DatabaseMigration::Models::NameValuePair>

An array of name-value pair attribute entries.

Returns:



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

def additional_attributes
  @additional_attributes
end

#database_name ⇒ String

[Required] The name of the database being referenced.

Returns:

  • (String) 


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

def database_name
  @database_name
end

#db_system_id ⇒ String

The OCID of the database system being referenced.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 68

def db_system_id
  @db_system_id
end

#host ⇒ String

The IP Address of the host.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 20

def host
  @host
end

#port ⇒ Integer

The port to be used for the connection.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 24

def port
  @port
end

#security_protocol ⇒ String

[Required] Security Type for MySQL.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 32

def security_protocol
  @security_protocol
end

#ssl_ca ⇒ String

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 42

def ssl_ca
  @ssl_ca
end

#ssl_cert ⇒ String

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

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 55

def ssl_cert
  @ssl_cert
end

#ssl_crl ⇒ String

Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 49

def ssl_crl
  @ssl_crl
end

#ssl_key ⇒ String

Client Key - The client-key.pem containing the client private key (for 2-way SSL).

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 59

def ssl_key
  @ssl_key
end

#ssl_mode ⇒ String

SSL modes for MySQL.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 36

def ssl_mode
  @ssl_mode
end

#technology_type ⇒ String

[Required] The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 16

def technology_type
  @technology_type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 71

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',
    'subnet_id': :'subnetId',
    'nsg_ids': :'nsgIds',
    'username': :'username',
    'password': :'password',
    'replication_username': :'replicationUsername',
    'replication_password': :'replicationPassword',
    'technology_type': :'technologyType',
    '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',
    'additional_attributes': :'additionalAttributes',
    'db_system_id': :'dbSystemId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
132
133
134
135
136
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 105

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',
    'subnet_id': :'String',
    'nsg_ids': :'Array<String>',
    'username': :'String',
    'password': :'String',
    'replication_username': :'String',
    'replication_password': :'String',
    'technology_type': :'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',
    'additional_attributes': :'Array<OCI::DatabaseMigration::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



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/database_migration/models/create_mysql_connection_details.rb', line 251

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 &&
    subnet_id == other.subnet_id &&
    nsg_ids == other.nsg_ids &&
    username == other.username &&
    password == other.password &&
    replication_username == other.replication_username &&
    replication_password == other.replication_password &&
    technology_type == other.technology_type &&
    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 &&
    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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 306

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


286
287
288
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 286

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 295

def hash
  [connection_type, display_name, description, compartment_id, freeform_tags, defined_tags, vault_id, key_id, subnet_id, nsg_ids, username, password, replication_username, replication_password, technology_type, host, port, database_name, security_protocol, ssl_mode, ssl_ca, ssl_crl, ssl_cert, ssl_key, 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



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 339

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



333
334
335
 
# File 'lib/oci/database_migration/models/create_mysql_connection_details.rb', line 333

def to_s
  to_hash.to_s
end