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

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

The properties of GoldengateMicrosoftSqlserverConnection.

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

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

Optional. The technology type of MicrosoftSqlserverConnection.
↳ database string

Optional. The name of the database.
↳ host string

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

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

Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server.
↳ additional_attributes array<NameValuePair>

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

Optional. Security Type for Microsoft SQL Server.
↳ ssl_ca_file string

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

Optional. If set to true, the driver validates the certificate that is sent by the database server.

getPassword

Optional. Input only. The password Oracle Goldengate uses for Microsoft SQL Server connection in plain text.

Returns
Type Description
string

hasPassword

setPassword

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

Parameter
Name Description
var string
Returns
Type Description
$this

getTechnologyType

Optional. The technology type of MicrosoftSqlserverConnection.

Returns
Type Description
string

setTechnologyType

Optional. The technology type of MicrosoftSqlserverConnection.

Parameter
Name Description
var string
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

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

getUsername

Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server.

Returns
Type Description
string

setUsername

Optional. The username Oracle Goldengate uses to connect to the Microsoft SQL Server.

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

getSecurityProtocol

Optional. Security Type for Microsoft SQL Server.

Returns
Type Description
int Enum of type MicrosoftSqlserverSecurityProtocol.

setSecurityProtocol

Optional. Security Type for Microsoft SQL Server.

Parameter
Name Description
var int

Enum of type MicrosoftSqlserverSecurityProtocol.

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-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-way SSL).

Parameter
Name Description
var string
Returns
Type Description
$this

getServerCertificateValidationRequired

Optional. If set to true, the driver validates the certificate that is sent by the database server.

Returns
Type Description
bool

setServerCertificateValidationRequired

Optional. If set to true, the driver validates the certificate that is sent by the database server.

Parameter
Name Description
var bool
Returns
Type Description
$this

getConnectionPasswordOptions

Returns
Type Description
string