File: //lib/mysqlsh/lib/python3.8/site-packages/oci/golden_gate/models/update_mysql_connection_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20200407
from .update_connection_details import UpdateConnectionDetails
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class UpdateMysqlConnectionDetails(UpdateConnectionDetails):
"""
The information to update a MySQL Connection.
"""
def __init__(self, **kwargs):
"""
Initializes a new UpdateMysqlConnectionDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.golden_gate.models.UpdateMysqlConnectionDetails.connection_type` attribute
of this class is ``MYSQL`` and it should not be changed.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param connection_type:
The value to assign to the connection_type property of this UpdateMysqlConnectionDetails.
Allowed values for this property are: "GOLDENGATE", "KAFKA", "KAFKA_SCHEMA_REGISTRY", "MYSQL", "JAVA_MESSAGE_SERVICE", "MICROSOFT_SQLSERVER", "OCI_OBJECT_STORAGE", "ORACLE", "AZURE_DATA_LAKE_STORAGE", "POSTGRESQL", "AZURE_SYNAPSE_ANALYTICS", "SNOWFLAKE", "AMAZON_S3", "HDFS", "ORACLE_NOSQL", "MONGODB", "AMAZON_KINESIS", "AMAZON_REDSHIFT", "DB2", "REDIS", "ELASTICSEARCH", "GENERIC", "GOOGLE_CLOUD_STORAGE", "GOOGLE_BIGQUERY", "DATABRICKS", "GOOGLE_PUBSUB", "MICROSOFT_FABRIC"
:type connection_type: str
:param display_name:
The value to assign to the display_name property of this UpdateMysqlConnectionDetails.
:type display_name: str
:param description:
The value to assign to the description property of this UpdateMysqlConnectionDetails.
:type description: str
:param freeform_tags:
The value to assign to the freeform_tags property of this UpdateMysqlConnectionDetails.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this UpdateMysqlConnectionDetails.
:type defined_tags: dict(str, dict(str, object))
:param vault_id:
The value to assign to the vault_id property of this UpdateMysqlConnectionDetails.
:type vault_id: str
:param key_id:
The value to assign to the key_id property of this UpdateMysqlConnectionDetails.
:type key_id: str
:param nsg_ids:
The value to assign to the nsg_ids property of this UpdateMysqlConnectionDetails.
:type nsg_ids: list[str]
:param subnet_id:
The value to assign to the subnet_id property of this UpdateMysqlConnectionDetails.
:type subnet_id: str
:param routing_method:
The value to assign to the routing_method property of this UpdateMysqlConnectionDetails.
Allowed values for this property are: "SHARED_SERVICE_ENDPOINT", "SHARED_DEPLOYMENT_ENDPOINT", "DEDICATED_ENDPOINT"
:type routing_method: str
:param does_use_secret_ids:
The value to assign to the does_use_secret_ids property of this UpdateMysqlConnectionDetails.
:type does_use_secret_ids: bool
:param username:
The value to assign to the username property of this UpdateMysqlConnectionDetails.
:type username: str
:param password:
The value to assign to the password property of this UpdateMysqlConnectionDetails.
:type password: str
:param password_secret_id:
The value to assign to the password_secret_id property of this UpdateMysqlConnectionDetails.
:type password_secret_id: str
:param host:
The value to assign to the host property of this UpdateMysqlConnectionDetails.
:type host: str
:param port:
The value to assign to the port property of this UpdateMysqlConnectionDetails.
:type port: int
:param database_name:
The value to assign to the database_name property of this UpdateMysqlConnectionDetails.
:type database_name: str
:param security_protocol:
The value to assign to the security_protocol property of this UpdateMysqlConnectionDetails.
:type security_protocol: str
:param ssl_mode:
The value to assign to the ssl_mode property of this UpdateMysqlConnectionDetails.
:type ssl_mode: str
:param ssl_ca:
The value to assign to the ssl_ca property of this UpdateMysqlConnectionDetails.
:type ssl_ca: str
:param ssl_crl:
The value to assign to the ssl_crl property of this UpdateMysqlConnectionDetails.
:type ssl_crl: str
:param ssl_cert:
The value to assign to the ssl_cert property of this UpdateMysqlConnectionDetails.
:type ssl_cert: str
:param ssl_key:
The value to assign to the ssl_key property of this UpdateMysqlConnectionDetails.
:type ssl_key: str
:param ssl_key_secret_id:
The value to assign to the ssl_key_secret_id property of this UpdateMysqlConnectionDetails.
:type ssl_key_secret_id: str
:param private_ip:
The value to assign to the private_ip property of this UpdateMysqlConnectionDetails.
:type private_ip: str
:param additional_attributes:
The value to assign to the additional_attributes property of this UpdateMysqlConnectionDetails.
:type additional_attributes: list[oci.golden_gate.models.NameValuePair]
:param db_system_id:
The value to assign to the db_system_id property of this UpdateMysqlConnectionDetails.
:type db_system_id: str
"""
self.swagger_types = {
'connection_type': 'str',
'display_name': 'str',
'description': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'vault_id': 'str',
'key_id': 'str',
'nsg_ids': 'list[str]',
'subnet_id': 'str',
'routing_method': 'str',
'does_use_secret_ids': 'bool',
'username': 'str',
'password': 'str',
'password_secret_id': 'str',
'host': 'str',
'port': 'int',
'database_name': 'str',
'security_protocol': 'str',
'ssl_mode': 'str',
'ssl_ca': 'str',
'ssl_crl': 'str',
'ssl_cert': 'str',
'ssl_key': 'str',
'ssl_key_secret_id': 'str',
'private_ip': 'str',
'additional_attributes': 'list[NameValuePair]',
'db_system_id': 'str'
}
self.attribute_map = {
'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',
'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'
}
self._connection_type = None
self._display_name = None
self._description = None
self._freeform_tags = None
self._defined_tags = None
self._vault_id = None
self._key_id = None
self._nsg_ids = None
self._subnet_id = None
self._routing_method = None
self._does_use_secret_ids = None
self._username = None
self._password = None
self._password_secret_id = None
self._host = None
self._port = None
self._database_name = None
self._security_protocol = None
self._ssl_mode = None
self._ssl_ca = None
self._ssl_crl = None
self._ssl_cert = None
self._ssl_key = None
self._ssl_key_secret_id = None
self._private_ip = None
self._additional_attributes = None
self._db_system_id = None
self._connection_type = 'MYSQL'
@property
def username(self):
"""
Gets the username of this UpdateMysqlConnectionDetails.
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.
:return: The username of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._username
@username.setter
def username(self, username):
"""
Sets the username of this UpdateMysqlConnectionDetails.
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.
:param username: The username of this UpdateMysqlConnectionDetails.
:type: str
"""
self._username = username
@property
def password(self):
"""
Gets the password of this UpdateMysqlConnectionDetails.
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.
:return: The password of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._password
@password.setter
def password(self, password):
"""
Sets the password of this UpdateMysqlConnectionDetails.
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.
:param password: The password of this UpdateMysqlConnectionDetails.
:type: str
"""
self._password = password
@property
def password_secret_id(self):
"""
Gets the password_secret_id of this UpdateMysqlConnectionDetails.
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.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The password_secret_id of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._password_secret_id
@password_secret_id.setter
def password_secret_id(self, password_secret_id):
"""
Sets the password_secret_id of this UpdateMysqlConnectionDetails.
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.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param password_secret_id: The password_secret_id of this UpdateMysqlConnectionDetails.
:type: str
"""
self._password_secret_id = password_secret_id
@property
def host(self):
"""
Gets the host of this UpdateMysqlConnectionDetails.
The name or address of a host.
:return: The host of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._host
@host.setter
def host(self, host):
"""
Sets the host of this UpdateMysqlConnectionDetails.
The name or address of a host.
:param host: The host of this UpdateMysqlConnectionDetails.
:type: str
"""
self._host = host
@property
def port(self):
"""
Gets the port of this UpdateMysqlConnectionDetails.
The port of an endpoint usually specified for a connection.
:return: The port of this UpdateMysqlConnectionDetails.
:rtype: int
"""
return self._port
@port.setter
def port(self, port):
"""
Sets the port of this UpdateMysqlConnectionDetails.
The port of an endpoint usually specified for a connection.
:param port: The port of this UpdateMysqlConnectionDetails.
:type: int
"""
self._port = port
@property
def database_name(self):
"""
Gets the database_name of this UpdateMysqlConnectionDetails.
The name of the database.
:return: The database_name of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._database_name
@database_name.setter
def database_name(self, database_name):
"""
Sets the database_name of this UpdateMysqlConnectionDetails.
The name of the database.
:param database_name: The database_name of this UpdateMysqlConnectionDetails.
:type: str
"""
self._database_name = database_name
@property
def security_protocol(self):
"""
Gets the security_protocol of this UpdateMysqlConnectionDetails.
Security Type for MySQL.
:return: The security_protocol of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._security_protocol
@security_protocol.setter
def security_protocol(self, security_protocol):
"""
Sets the security_protocol of this UpdateMysqlConnectionDetails.
Security Type for MySQL.
:param security_protocol: The security_protocol of this UpdateMysqlConnectionDetails.
:type: str
"""
self._security_protocol = security_protocol
@property
def ssl_mode(self):
"""
Gets the ssl_mode of this UpdateMysqlConnectionDetails.
SSL modes for MySQL.
:return: The ssl_mode of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_mode
@ssl_mode.setter
def ssl_mode(self, ssl_mode):
"""
Sets the ssl_mode of this UpdateMysqlConnectionDetails.
SSL modes for MySQL.
:param ssl_mode: The ssl_mode of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_mode = ssl_mode
@property
def ssl_ca(self):
"""
Gets the ssl_ca of this UpdateMysqlConnectionDetails.
Database Certificate - The base64 encoded content of a .pem or .crt file.
containing the server public key (for 1 and 2-way SSL).
:return: The ssl_ca of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_ca
@ssl_ca.setter
def ssl_ca(self, ssl_ca):
"""
Sets the ssl_ca of this UpdateMysqlConnectionDetails.
Database Certificate - The base64 encoded content of a .pem or .crt file.
containing the server public key (for 1 and 2-way SSL).
:param ssl_ca: The ssl_ca of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_ca = ssl_ca
@property
def ssl_crl(self):
"""
Gets the ssl_crl of this UpdateMysqlConnectionDetails.
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.
:return: The ssl_crl of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_crl
@ssl_crl.setter
def ssl_crl(self, ssl_crl):
"""
Sets the ssl_crl of this UpdateMysqlConnectionDetails.
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.
:param ssl_crl: The ssl_crl of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_crl = ssl_crl
@property
def ssl_cert(self):
"""
Gets the ssl_cert of this UpdateMysqlConnectionDetails.
Client Certificate - The base64 encoded content of a .pem or .crt file.
containing the client public key (for 2-way SSL).
:return: The ssl_cert of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_cert
@ssl_cert.setter
def ssl_cert(self, ssl_cert):
"""
Sets the ssl_cert of this UpdateMysqlConnectionDetails.
Client Certificate - The base64 encoded content of a .pem or .crt file.
containing the client public key (for 2-way SSL).
:param ssl_cert: The ssl_cert of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_cert = ssl_cert
@property
def ssl_key(self):
"""
Gets the ssl_key of this UpdateMysqlConnectionDetails.
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.
:return: The ssl_key of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_key
@ssl_key.setter
def ssl_key(self, ssl_key):
"""
Sets the ssl_key of this UpdateMysqlConnectionDetails.
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.
:param ssl_key: The ssl_key of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_key = ssl_key
@property
def ssl_key_secret_id(self):
"""
Gets the ssl_key_secret_id of this UpdateMysqlConnectionDetails.
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.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The ssl_key_secret_id of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._ssl_key_secret_id
@ssl_key_secret_id.setter
def ssl_key_secret_id(self, ssl_key_secret_id):
"""
Sets the ssl_key_secret_id of this UpdateMysqlConnectionDetails.
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.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param ssl_key_secret_id: The ssl_key_secret_id of this UpdateMysqlConnectionDetails.
:type: str
"""
self._ssl_key_secret_id = ssl_key_secret_id
@property
def private_ip(self):
"""
Gets the private_ip of this UpdateMysqlConnectionDetails.
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.
:return: The private_ip of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._private_ip
@private_ip.setter
def private_ip(self, private_ip):
"""
Sets the private_ip of this UpdateMysqlConnectionDetails.
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.
:param private_ip: The private_ip of this UpdateMysqlConnectionDetails.
:type: str
"""
self._private_ip = private_ip
@property
def additional_attributes(self):
"""
Gets the additional_attributes of this UpdateMysqlConnectionDetails.
An array of name-value pair attribute entries.
Used as additional parameters in connection string.
:return: The additional_attributes of this UpdateMysqlConnectionDetails.
:rtype: list[oci.golden_gate.models.NameValuePair]
"""
return self._additional_attributes
@additional_attributes.setter
def additional_attributes(self, additional_attributes):
"""
Sets the additional_attributes of this UpdateMysqlConnectionDetails.
An array of name-value pair attribute entries.
Used as additional parameters in connection string.
:param additional_attributes: The additional_attributes of this UpdateMysqlConnectionDetails.
:type: list[oci.golden_gate.models.NameValuePair]
"""
self._additional_attributes = additional_attributes
@property
def db_system_id(self):
"""
Gets the db_system_id of this UpdateMysqlConnectionDetails.
The `OCID`__ of the database system being referenced.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:return: The db_system_id of this UpdateMysqlConnectionDetails.
:rtype: str
"""
return self._db_system_id
@db_system_id.setter
def db_system_id(self, db_system_id):
"""
Sets the db_system_id of this UpdateMysqlConnectionDetails.
The `OCID`__ of the database system being referenced.
__ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
:param db_system_id: The db_system_id of this UpdateMysqlConnectionDetails.
:type: str
"""
self._db_system_id = db_system_id
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other