Class: OCI::GoldenGate::Models::MysqlConnection
- Inherits:
-
Connection
- Object
- Connection
- OCI::GoldenGate::Models::MysqlConnection
- 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
-
#additional_attributes ⇒ Array<OCI::GoldenGate::Models::NameValuePair>
An array of name-value pair attribute entries.
-
#database_name ⇒ String
The name of the database.
-
#db_system_id ⇒ String
The OCID of the database system being referenced.
-
#host ⇒ String
The name or address of a host.
-
#password_secret_id ⇒ String
The OCID of the Secret where the password is stored.
-
#port ⇒ Integer
The port of an endpoint usually specified for a connection.
-
#private_ip ⇒ String
This property is not available when creating connections.
-
#security_protocol ⇒ String
[Required] Security Protocol for MySQL.
-
#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).
-
#ssl_cert ⇒ String
Client Certificate - The base64 encoded content of a .pem or .crt file containing the client public key (for 2-way SSL).
-
#ssl_crl ⇒ String
The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
-
#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).
-
#ssl_mode ⇒ String
SSL modes for MySQL.
-
#technology_type ⇒ String
[Required] The MySQL technology type.
-
#username ⇒ String
[Required] The username Oracle GoldenGate uses to connect the associated system of the given technology.
Attributes inherited from Connection
#cluster_placement_group_id, #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, #security_attributes, #subnet_id, #subscription_id, #system_tags, #time_created, #time_updated, #vault_id
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MysqlConnection
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Methods inherited from Connection
Constructor Details
#initialize(attributes = {}) ⇒ MysqlConnection
Initializes the object
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 306 307 308 309 310 311 312 313 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 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 270 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.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.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.
112 113 114 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 112 def additional_attributes @additional_attributes end |
#database_name ⇒ String
The name of the database.
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.
117 118 119 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 117 def db_system_id @db_system_id end |
#host ⇒ String
The name or address of a host.
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.
126 127 128 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 126 def password_secret_id @password_secret_id end |
#port ⇒ Integer
The port of an endpoint usually specified for a connection.
65 66 67 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 65 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.
106 107 108 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 106 def private_ip @private_ip end |
#security_protocol ⇒ String
[Required] Security Protocol for MySQL.
74 75 76 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 74 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.
85 86 87 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 85 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.
99 100 101 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 99 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.
92 93 94 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 92 def ssl_crl @ssl_crl 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.
133 134 135 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 133 def ssl_key_secret_id @ssl_key_secret_id end |
#ssl_mode ⇒ String
SSL modes for MySQL.
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.
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.
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.
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 136 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', 'subscription_id': :'subscriptionId', 'cluster_placement_group_id': :'clusterPlacementGroupId', 'security_attributes': :'securityAttributes', 'technology_type': :'technologyType', 'username': :'username', 'host': :'host', 'port': :'port', 'database_name': :'databaseName', 'security_protocol': :'securityProtocol', 'ssl_mode': :'sslMode', 'ssl_ca': :'sslCa', 'ssl_crl': :'sslCrl', 'ssl_cert': :'sslCert', '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.
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 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 182 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', 'subscription_id': :'String', 'cluster_placement_group_id': :'String', 'security_attributes': :'Hash<String, Hash<String, Object>>', 'technology_type': :'String', 'username': :'String', 'host': :'String', 'port': :'Integer', 'database_name': :'String', 'security_protocol': :'String', 'ssl_mode': :'String', 'ssl_ca': :'String', 'ssl_crl': :'String', 'ssl_cert': :'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.
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 405 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 && == other. && == other. && == other. && 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 && subscription_id == other.subscription_id && cluster_placement_group_id == other.cluster_placement_group_id && security_attributes == other.security_attributes && 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 && ssl_ca == other.ssl_ca && ssl_crl == other.ssl_crl && ssl_cert == other.ssl_cert && 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
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 472 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
452 453 454 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 452 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
461 462 463 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 461 def hash [connection_type, id, display_name, description, compartment_id, , , , 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, subscription_id, cluster_placement_group_id, security_attributes, technology_type, username, host, port, database_name, security_protocol, ssl_mode, ssl_ca, ssl_crl, ssl_cert, 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
505 506 507 508 509 510 511 512 513 514 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 505 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
499 500 501 |
# File 'lib/oci/golden_gate/models/mysql_connection.rb', line 499 def to_s to_hash.to_s end |