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

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

The properties of Goldengate Oracle Database Connection.

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

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 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. Format: projects/{project}/secrets/{secret}/versions/{version}.

↳ technology_type string

Optional. The technology type.

↳ username string

Optional. The username Oracle Goldengate uses to connect.

↳ authentication_mode int

Optional. Authentication mode.

↳ connection_string string

Optional. Connect descriptor or Easy Connect Naming method used to connect to a database.

↳ session_mode int

Optional. The mode of the database connection session to be established by the data client.

↳ gcp_oracle_database_id string

Optional. Autonomous AI Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty. Format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}

↳ wallet_file string

Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded.

getPassword

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

Returns
Type Description
string

hasPassword

setPassword

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTechnologyType

Optional. The technology type.

Returns
Type Description
string

setTechnologyType

Optional. The technology type.

Parameter
Name Description
var string
Returns
Type Description
$this

getUsername

Optional. The username Oracle Goldengate uses to connect.

Returns
Type Description
string

setUsername

Optional. The username Oracle Goldengate uses to connect.

Parameter
Name Description
var string
Returns
Type Description
$this

getAuthenticationMode

Optional. Authentication mode.

Returns
Type Description
int Enum of type OracleAuthenticationMode.

setAuthenticationMode

Optional. Authentication mode.

Parameter
Name Description
var int

Enum of type OracleAuthenticationMode.

Returns
Type Description
$this

getConnectionString

Optional. Connect descriptor or Easy Connect Naming method used to connect to a database.

Returns
Type Description
string

setConnectionString

Optional. Connect descriptor or Easy Connect Naming method used to connect to a database.

Parameter
Name Description
var string
Returns
Type Description
$this

getSessionMode

Optional. The mode of the database connection session to be established by the data client.

Returns
Type Description
int Enum of type SessionMode.

setSessionMode

Optional. The mode of the database connection session to be established by the data client.

Parameter
Name Description
var int

Enum of type SessionMode.

Returns
Type Description
$this

getGcpOracleDatabaseId

Optional. Autonomous AI Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty. Format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}

Returns
Type Description
string

setGcpOracleDatabaseId

Optional. Autonomous AI Database instance id of database in Oracle Database @ Google Cloud. If gcp_oracle_database_id is provided, connection_string must be empty. Format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}

Parameter
Name Description
var string
Returns
Type Description
$this

getWalletFile

Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded.

Returns
Type Description
string

setWalletFile

Optional. The wallet contents Oracle Goldengate uses to make connections to a database. This attribute is expected to be base64 encoded.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectionPasswordOptions

Returns
Type Description
string