Google Cloud Oracle Database V1 Client - Class GoldengateMysqlConnectionProperties (0.9.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateMysqlConnectionProperties.

Properties of GoldengateMysqlConnection.

Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateMysqlConnectionProperties

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ password string

Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text.
↳ password_secret_version string

Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}.
↳ technology_type string

Optional. The technology type of MysqlConnection.
↳ username string

Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.
↳ host string

Optional. The name or address of a host.
↳ port int

Optional. The port of an endpoint usually specified for a connection.
↳ database string

Optional. The name of the database.
↳ security_protocol int

Optional. Security Type for MySQL.
↳ ssl_mode int

Optional. SSL modes for MySQL.
↳ ssl_ca_file string

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

Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).
↳ ssl_cert_file string

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

Optional. Client Key - The base64 encoded content of a .pem or .crt file containing the client private key (for 2-way SSL).
↳ additional_attributes array<NameValuePair>

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

Optional. The OCID of the database system being referenced.

getPassword

Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text.

Returns
Type Description
string

hasPassword

setPassword

Optional. Input only. The password Oracle Goldengate uses to connect to MySQL in plain text.

Parameter
Name Description
var string
Returns
Type Description
$this

getPasswordSecretVersion

Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}.

Returns
Type Description
string

hasPasswordSecretVersion

setPasswordSecretVersion

Optional. Input only. The resource name of a secret version in Secret Manager which contains the password Oracle Goldengate uses to connect to MySQL. Format: projects/{project}/secrets/{secret}/versions/{version}.

Parameter
Name Description
var string
Returns
Type Description
$this

getTechnologyType

Optional. The technology type of MysqlConnection.

Returns
Type Description
string

setTechnologyType

Optional. The technology type of MysqlConnection.

Parameter
Name Description
var string
Returns
Type Description
$this

getUsername

Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.

Returns
Type Description
string

setUsername

Optional. The username Oracle Goldengate uses to connect the associated system of the given technology.

Parameter
Name Description
var string
Returns
Type Description
$this

getHost

Optional. The name or address of a host.

Returns
Type Description
string

setHost

Optional. The name or address of a host.

Parameter
Name Description
var string
Returns
Type Description
$this

getPort

Optional. The port of an endpoint usually specified for a connection.

Returns
Type Description
int

setPort

Optional. The port of an endpoint usually specified for a connection.

Parameter
Name Description
var int
Returns
Type Description
$this

getDatabase

Optional. The name of the database.

Returns
Type Description
string

setDatabase

Optional. The name of the database.

Parameter
Name Description
var string
Returns
Type Description
$this

getSecurityProtocol

Optional. Security Type for MySQL.

Returns
Type Description
int Enum of type MysqlSecurityProtocol.

setSecurityProtocol

Optional. Security Type for MySQL.

Parameter
Name Description
var int

Enum of type MysqlSecurityProtocol.

Returns
Type Description
$this

getSslMode

Optional. SSL modes for MySQL.

Returns
Type Description
int Enum of type SSLMode.

setSslMode

Optional. SSL modes for MySQL.

Parameter
Name Description
var int

Enum of type SSLMode.

Returns
Type Description
$this

getSslCaFile

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

Returns
Type Description
string

setSslCaFile

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSslCrlFile

Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

Returns
Type Description
string

setSslCrlFile

Optional. The base64 encoded list of certificates revoked by the trusted certificate authorities (Trusted CA).

Parameter
Name Description
var string
Returns
Type Description
$this

getSslCertFile

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

Returns
Type Description
string

setSslCertFile

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSslKeyFile

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

Returns
Type Description
string

setSslKeyFile

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAdditionalAttributes

Optional. An array of name-value pair attribute entries.

Used as additional parameters in connection string.

Returns
Type Description
Google\Protobuf\RepeatedField<NameValuePair>

setAdditionalAttributes

Optional. An array of name-value pair attribute entries.

Used as additional parameters in connection string.

Parameter
Name Description
var array<NameValuePair>
Returns
Type Description
$this

getDbSystemId

Optional. The OCID of the database system being referenced.

Returns
Type Description
string

setDbSystemId

Optional. The OCID of the database system being referenced.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectionPasswordOptions

Returns
Type Description
string