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

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

The properties of GoldengateDb2Connection.

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

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 for Db2 connection 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 for Db2 connection. Format: projects/{project}/secrets/{secret}/versions/{version}.
↳ technology_type string

Optional. The technology type of Db2Connection.
↳ 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.
↳ username string

Optional. The username Oracle Goldengate uses to connect to the DB2 database.
↳ security_protocol int

Optional. Security protocol for the DB2 database.
↳ additional_attributes array<NameValuePair>

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

Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i.
↳ ssl_client_keystash_file string

Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i.
↳ ssl_server_certificate_file string

Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

getPassword

Optional. Input only. The password Oracle Goldengate uses for Db2 connection in plain text.

Returns
Type Description
string

hasPassword

setPassword

Optional. Input only. The password Oracle Goldengate uses for Db2 connection 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 for Db2 connection. 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 for Db2 connection. Format: projects/{project}/secrets/{secret}/versions/{version}.

Parameter
Name Description
var string
Returns
Type Description
$this

getTechnologyType

Optional. The technology type of Db2Connection.

Returns
Type Description
string

setTechnologyType

Optional. The technology type of Db2Connection.

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

getUsername

Optional. The username Oracle Goldengate uses to connect to the DB2 database.

Returns
Type Description
string

setUsername

Optional. The username Oracle Goldengate uses to connect to the DB2 database.

Parameter
Name Description
var string
Returns
Type Description
$this

getSecurityProtocol

Optional. Security protocol for the DB2 database.

Returns
Type Description
int Enum of type Db2SecurityProtocol.

setSecurityProtocol

Optional. Security protocol for the DB2 database.

Parameter
Name Description
var int

Enum of type Db2SecurityProtocol.

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

getSslClientKeystoredbFile

Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i.

Returns
Type Description
string

setSslClientKeystoredbFile

Optional. The keystore file created at the client containing the server certificate / CA root certificate. Not supported for IBM Db2 for i.

Parameter
Name Description
var string
Returns
Type Description
$this

getSslClientKeystashFile

Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i.

Returns
Type Description
string

setSslClientKeystashFile

Optional. The keystash file which contains the encrypted password to the key database file. Not supported for IBM Db2 for i.

Parameter
Name Description
var string
Returns
Type Description
$this

getSslServerCertificateFile

Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

Returns
Type Description
string

setSslServerCertificateFile

Optional. The file which contains the self-signed server certificate / Certificate Authority (CA) certificate.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectionPasswordOptions

Returns
Type Description
string