Google Cloud Dms V1 Client - Class PostgreSqlConnectionProfile (1.0.5)

Reference documentation and code samples for the Google Cloud Dms V1 Client class PostgreSqlConnectionProfile.

Specifies connection parameters required specifically for PostgreSQL databases.

Generated from protobuf message google.cloud.clouddms.v1.PostgreSqlConnectionProfile

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ host string

Required. The IP or hostname of the source PostgreSQL database.

↳ port int

Required. The network port of the source PostgreSQL database.

↳ username string

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

↳ password string

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

↳ password_set bool

Output only. Indicates If this connection profile password is stored.

↳ ssl Google\Cloud\CloudDms\V1\SslConfig

SSL configuration for the destination to connect to the source database.

↳ cloud_sql_id string

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

getHost

Required. The IP or hostname of the source PostgreSQL database.

Returns
TypeDescription
string

setHost

Required. The IP or hostname of the source PostgreSQL database.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPort

Required. The network port of the source PostgreSQL database.

Returns
TypeDescription
int

setPort

Required. The network port of the source PostgreSQL database.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getUsername

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

Returns
TypeDescription
string

setUsername

Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPassword

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

Returns
TypeDescription
string

setPassword

Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPasswordSet

Output only. Indicates If this connection profile password is stored.

Returns
TypeDescription
bool

setPasswordSet

Output only. Indicates If this connection profile password is stored.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSsl

SSL configuration for the destination to connect to the source database.

Returns
TypeDescription
Google\Cloud\CloudDms\V1\SslConfig|null

hasSsl

clearSsl

setSsl

SSL configuration for the destination to connect to the source database.

Parameter
NameDescription
var Google\Cloud\CloudDms\V1\SslConfig
Returns
TypeDescription
$this

getCloudSqlId

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

Returns
TypeDescription
string

setCloudSqlId

If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

Parameter
NameDescription
var string
Returns
TypeDescription
$this