Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::PostgreSqlConnectionProfile.
Specifies connection parameters required specifically for PostgreSQL
databases.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#cloud_sql_id
defcloud_sql_id()->::String
Returns
(::String) — If the source is a Cloud SQL database, use this field to
provide the Cloud SQL instance ID of the source.
#cloud_sql_id=
defcloud_sql_id=(value)->::String
Parameter
value (::String) — If the source is a Cloud SQL database, use this field to
provide the Cloud SQL instance ID of the source.
Returns
(::String) — If the source is a Cloud SQL database, use this field to
provide the Cloud SQL instance ID of the source.
#host
defhost()->::String
Returns
(::String) — Required. The IP or hostname of the source PostgreSQL database.
#host=
defhost=(value)->::String
Parameter
value (::String) — Required. The IP or hostname of the source PostgreSQL database.
Returns
(::String) — Required. The IP or hostname of the source PostgreSQL database.
(::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=
defpassword=(value)->::String
Parameter
value (::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.
Returns
(::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
defpassword_set()->::Boolean
Returns
(::Boolean) — Output only. Indicates If this connection profile password is stored.
#port
defport()->::Integer
Returns
(::Integer) — Required. The network port of the source PostgreSQL database.
#port=
defport=(value)->::Integer
Parameter
value (::Integer) — Required. The network port of the source PostgreSQL database.
Returns
(::Integer) — Required. The network port of the source PostgreSQL database.
Note: The following fields are mutually exclusive: private_service_connect_connectivity, static_ip_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: private_service_connect_connectivity, static_ip_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: private_service_connect_connectivity, static_ip_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: static_ip_connectivity, private_service_connect_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: static_ip_connectivity, private_service_connect_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: static_ip_connectivity, private_service_connect_connectivity. If a field in that set is populated, all other fields in the set will automatically be cleared.
#username
defusername()->::String
Returns
(::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.
#username=
defusername=(value)->::String
Parameter
value (::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.
Returns
(::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.
[[["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-09 UTC."],[],[],null,["# Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::PostgreSqlConnectionProfile (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-cloud_dms-v1/latest/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [1.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.3.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [1.2.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.2.2/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [1.1.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.1.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [1.0.1](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.0.1/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.8.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.8.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.7.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.7.2/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.6.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.6.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.5.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.5.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.4.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.4.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.3.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.2.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.2.0/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile)\n- [0.1.5](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.1.5/Google-Cloud-CloudDMS-V1-PostgreSqlConnectionProfile) \nReference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::PostgreSqlConnectionProfile.\n\nSpecifies connection parameters required specifically for PostgreSQL\ndatabases. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #cloud_sql_id\n\n def cloud_sql_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.\n\n### #cloud_sql_id=\n\n def cloud_sql_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. \n**Returns**\n\n- (::String) --- If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.\n\n### #host\n\n def host() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The IP or hostname of the source PostgreSQL database.\n\n### #host=\n\n def host=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The IP or hostname of the source PostgreSQL database. \n**Returns**\n\n- (::String) --- Required. The IP or hostname of the source PostgreSQL database.\n\n### #network_architecture\n\n def network_architecture() -\u003e ::Google::Cloud::CloudDMS::V1::NetworkArchitecture\n\n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::NetworkArchitecture](./Google-Cloud-CloudDMS-V1-NetworkArchitecture)) --- Output only. If the source is a Cloud SQL database, this field indicates the network architecture it's associated with.\n\n### #password\n\n def password() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #password=\n\n def password=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #password_set\n\n def password_set() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Output only. Indicates If this connection profile password is stored.\n\n### #port\n\n def port() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Required. The network port of the source PostgreSQL database.\n\n### #port=\n\n def port=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Required. The network port of the source PostgreSQL database. \n**Returns**\n\n- (::Integer) --- Required. The network port of the source PostgreSQL database.\n\n### #private_service_connect_connectivity\n\n def private_service_connect_connectivity() -\u003e ::Google::Cloud::CloudDMS::V1::PrivateServiceConnectConnectivity\n\n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::PrivateServiceConnectConnectivity](./Google-Cloud-CloudDMS-V1-PrivateServiceConnectConnectivity)) --- Private service connect connectivity.\n\n\n Note: The following fields are mutually exclusive: `private_service_connect_connectivity`, `static_ip_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #private_service_connect_connectivity=\n\n def private_service_connect_connectivity=(value) -\u003e ::Google::Cloud::CloudDMS::V1::PrivateServiceConnectConnectivity\n\n**Parameter**\n\n- **value** ([::Google::Cloud::CloudDMS::V1::PrivateServiceConnectConnectivity](./Google-Cloud-CloudDMS-V1-PrivateServiceConnectConnectivity)) --- Private service connect connectivity.\n\n\nNote: The following fields are mutually exclusive: `private_service_connect_connectivity`, `static_ip_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::PrivateServiceConnectConnectivity](./Google-Cloud-CloudDMS-V1-PrivateServiceConnectConnectivity)) --- Private service connect connectivity.\n\n\n Note: The following fields are mutually exclusive: `private_service_connect_connectivity`, `static_ip_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #ssl\n\n def ssl() -\u003e ::Google::Cloud::CloudDMS::V1::SslConfig\n\n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::SslConfig](./Google-Cloud-CloudDMS-V1-SslConfig)) --- SSL configuration for the destination to connect to the source database.\n\n### #ssl=\n\n def ssl=(value) -\u003e ::Google::Cloud::CloudDMS::V1::SslConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::CloudDMS::V1::SslConfig](./Google-Cloud-CloudDMS-V1-SslConfig)) --- SSL configuration for the destination to connect to the source database. \n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::SslConfig](./Google-Cloud-CloudDMS-V1-SslConfig)) --- SSL configuration for the destination to connect to the source database.\n\n### #static_ip_connectivity\n\n def static_ip_connectivity() -\u003e ::Google::Cloud::CloudDMS::V1::StaticIpConnectivity\n\n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::StaticIpConnectivity](./Google-Cloud-CloudDMS-V1-StaticIpConnectivity)) --- Static ip connectivity data (default, no additional details needed).\n\n\n Note: The following fields are mutually exclusive: `static_ip_connectivity`, `private_service_connect_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #static_ip_connectivity=\n\n def static_ip_connectivity=(value) -\u003e ::Google::Cloud::CloudDMS::V1::StaticIpConnectivity\n\n**Parameter**\n\n- **value** ([::Google::Cloud::CloudDMS::V1::StaticIpConnectivity](./Google-Cloud-CloudDMS-V1-StaticIpConnectivity)) --- Static ip connectivity data (default, no additional details needed).\n\n\nNote: The following fields are mutually exclusive: `static_ip_connectivity`, `private_service_connect_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::StaticIpConnectivity](./Google-Cloud-CloudDMS-V1-StaticIpConnectivity)) --- Static ip connectivity data (default, no additional details needed).\n\n\n Note: The following fields are mutually exclusive: `static_ip_connectivity`, `private_service_connect_connectivity`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #username\n\n def username() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #username=\n\n def username=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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."]]
