Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateMongodbConnectionProperties.
The properties of GoldengateMongodbConnection.
Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateMongodbConnectionProperties
Namespace
Google \ Cloud \ OracleDatabase \ V1Methods
__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 the Mongodb 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 to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ tls_certificate_key_file_password |
string
Optional. Input only. The Client Certificate key file password in plain text. |
↳ tls_certificate_key_file_password_secret_version |
string
Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}. |
↳ technology_type |
string
Optional. The technology type of MongodbConnection. |
↳ connection_string |
string
Optional. MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords' |
↳ username |
string
Optional. The username Oracle Goldengate uses to connect to the database. |
↳ database_id |
string
Optional. The OCID of the Oracle Autonomous Json Database. |
↳ security_protocol |
int
Optional. Security Type for MongoDB. |
↳ tls_ca_file |
string
Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). |
↳ tls_certificate_key_file |
string
Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). |
getPassword
Optional. Input only. The password Oracle Goldengate uses to connect the Mongodb connection in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPassword
setPassword
Optional. Input only. The password Oracle Goldengate uses to connect the Mongodb 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 to connect the Mongodb 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 to connect the Mongodb connection. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTlsCertificateKeyFilePassword
Optional. Input only. The Client Certificate key file password in plain text.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTlsCertificateKeyFilePassword
setTlsCertificateKeyFilePassword
Optional. Input only. The Client Certificate key file password in plain text.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTlsCertificateKeyFilePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTlsCertificateKeyFilePasswordSecretVersion
setTlsCertificateKeyFilePasswordSecretVersion
Optional. Input only. The resource name of a secret version in Secret Manager which contains the Client Certificate key file password in Secret Manager. Format: projects/{project}/secrets/{secret}/versions/{version}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTechnologyType
Optional. The technology type of MongodbConnection.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTechnologyType
Optional. The technology type of MongodbConnection.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionString
Optional. MongoDB connection string.
e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
| Returns | |
|---|---|
| Type | Description |
string |
|
setConnectionString
Optional. MongoDB connection string.
e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUsername
Optional. The username Oracle Goldengate uses to connect to the database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUsername
Optional. The username Oracle Goldengate uses to connect to the database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
Optional. The OCID of the Oracle Autonomous Json Database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
Optional. The OCID of the Oracle Autonomous Json Database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecurityProtocol
Optional. Security Type for MongoDB.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type MongodbSecurityProtocol. |
setSecurityProtocol
Optional. Security Type for MongoDB.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type MongodbSecurityProtocol. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTlsCaFile
Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
| Returns | |
|---|---|
| Type | Description |
string |
|
setTlsCaFile
Optional. Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTlsCertificateKeyFile
Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).
| Returns | |
|---|---|
| Type | Description |
string |
|
setTlsCertificateKeyFile
Optional. Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectionPasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|
getTlsCertificateKeyFilePasswordOptions
| Returns | |
|---|---|
| Type | Description |
string |
|