Package com.oracle.bmc.goldengate.model

Class MysqlConnection

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class MysqlConnection
extends Connection
    Represents the metadata of a MySQL Connection.
    Note: Objects should always be created or deserialized using the MysqlConnection.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the MysqlConnection.Builder, which maintain a set of all explicitly set fields called MysqlConnection.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getUsername

        public String getUsername()
        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:
        the value

      • getHost

        public String getHost()
        The name or address of a host.
        Returns:
        the value

      • getPort

        public Integer getPort()
        The port of an endpoint usually specified for a connection.
        Returns:
        the value

      • getDatabaseName

        public String getDatabaseName()
        The name of the database.
        Returns:
        the value

      • getSslCa

        public String getSslCa()
        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.

        Returns:
        the value

      • getSslCrl

        public String getSslCrl()
        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.

        Returns:
        the value

      • getSslCert

        public String getSslCert()
        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.

        Returns:
        the value

      • getPrivateIp

        public String getPrivateIp()
        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:
        the value

      • getAdditionalAttributes

        public List<NameValuePair> getAdditionalAttributes()
        An array of name-value pair attribute entries.

        Used as additional parameters in connection string.

        Returns:
        the value

      • getDbSystemId

        public String getDbSystemId()
        The OCID of the database system being referenced.
        Returns:
        the value

      • getPasswordSecretId

        public String getPasswordSecretId()
        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:
        the value

      • getSslKeySecretId

        public String getSslKeySecretId()
        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:
        the value

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class Connection
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation