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 messagegoogle.cloud.clouddms.v1.PostgreSqlConnectionProfile
Namespace
Google \ Cloud \ CloudDms \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
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.
Required. The IP or hostname of the source PostgreSQL database.
Returns
Type
Description
string
setHost
Required. The IP or hostname of the source PostgreSQL database.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPort
Required. The network port of the source PostgreSQL database.
Returns
Type
Description
int
setPort
Required. The network port of the source PostgreSQL database.
Parameter
Name
Description
var
int
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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
Name
Description
var
string
Returns
Type
Description
$this
getPasswordSet
Output only. Indicates If this connection profile password is stored.
Returns
Type
Description
bool
setPasswordSet
Output only. Indicates If this connection profile password is stored.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getSsl
SSL configuration for the destination to connect to the source database.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dms V1 Client - Class PostgreSqlConnectionProfile (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.PostgreSqlConnectionProfile)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.PostgreSqlConnectionProfile)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.PostgreSqlConnectionProfile)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.PostgreSqlConnectionProfile)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.PostgreSqlConnectionProfile)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.PostgreSqlConnectionProfile)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.PostgreSqlConnectionProfile)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.PostgreSqlConnectionProfile) \nReference documentation and code samples for the Google Cloud Dms V1 Client class PostgreSqlConnectionProfile.\n\nSpecifies connection parameters required specifically for PostgreSQL\ndatabases.\n\nGenerated from protobuf message `google.cloud.clouddms.v1.PostgreSqlConnectionProfile`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getHost\n\nRequired. The IP or hostname of the source PostgreSQL database.\n\n### setHost\n\nRequired. The IP or hostname of the source PostgreSQL database.\n\n### getPort\n\nRequired. The network port of the source PostgreSQL database.\n\n### setPort\n\nRequired. The network port of the source PostgreSQL database.\n\n### getUsername\n\nRequired. The username that Database Migration Service will use to connect\nto the database. The value is encrypted when stored in Database Migration\nService.\n\n### setUsername\n\nRequired. The username that Database Migration Service will use to connect\nto the database. The value is encrypted when stored in Database Migration\nService.\n\n### getPassword\n\nRequired. Input only. The password for the user that Database Migration\nService will be using to connect to the database. This field is not\nreturned on request, and the value is encrypted when stored in Database\nMigration Service.\n\n### setPassword\n\nRequired. Input only. The password for the user that Database Migration\nService will be using to connect to the database. This field is not\nreturned on request, and the value is encrypted when stored in Database\nMigration Service.\n\n### getPasswordSet\n\nOutput only. Indicates If this connection profile password is stored.\n\n### setPasswordSet\n\nOutput only. Indicates If this connection profile password is stored.\n\n### getSsl\n\nSSL configuration for the destination to connect to the source database.\n\n### hasSsl\n\n### clearSsl\n\n### setSsl\n\nSSL configuration for the destination to connect to the source database.\n\n### getCloudSqlId\n\nIf the source is a Cloud SQL database, use this field to\nprovide the Cloud SQL instance ID of the source.\n\n### setCloudSqlId\n\nIf the source is a Cloud SQL database, use this field to\nprovide the Cloud SQL instance ID of the source.\n\n### getNetworkArchitecture\n\nOutput only. If the source is a Cloud SQL database, this field indicates\nthe network architecture it's associated with.\n\n### setNetworkArchitecture\n\nOutput only. If the source is a Cloud SQL database, this field indicates\nthe network architecture it's associated with.\n\n### getStaticIpConnectivity\n\nStatic ip connectivity data (default, no additional details needed).\n\n### hasStaticIpConnectivity\n\n### setStaticIpConnectivity\n\nStatic ip connectivity data (default, no additional details needed).\n\n### getPrivateServiceConnectConnectivity\n\nPrivate service connect connectivity.\n\n### hasPrivateServiceConnectConnectivity\n\n### setPrivateServiceConnectConnectivity\n\nPrivate service connect connectivity.\n\n### getConnectivity"]]
