Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::ForwardSshTunnelConnectivity.
Forward SSH Tunnel connectivity.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#hostname
defhostname()->::String
Returns
(::String) — Required. Hostname for the SSH tunnel.
#hostname=
defhostname=(value)->::String
Parameter
value (::String) — Required. Hostname for the SSH tunnel.
Returns
(::String) — Required. Hostname for the SSH tunnel.
#password
defpassword()->::String
Returns
(::String) — Input only. SSH password.
Note: The following fields are mutually exclusive: password, private_key. If a field in that set is populated, all other fields in the set will automatically be cleared.
#password=
defpassword=(value)->::String
Parameter
value (::String) — Input only. SSH password.
Note: The following fields are mutually exclusive: password, private_key. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Input only. SSH password.
Note: The following fields are mutually exclusive: password, private_key. If a field in that set is populated, all other fields in the set will automatically be cleared.
#port
defport()->::Integer
Returns
(::Integer) — Port for the SSH tunnel, default value is 22.
#port=
defport=(value)->::Integer
Parameter
value (::Integer) — Port for the SSH tunnel, default value is 22.
Returns
(::Integer) — Port for the SSH tunnel, default value is 22.
#private_key
defprivate_key()->::String
Returns
(::String) — Input only. SSH private key.
Note: The following fields are mutually exclusive: private_key, password. If a field in that set is populated, all other fields in the set will automatically be cleared.
#private_key=
defprivate_key=(value)->::String
Parameter
value (::String) — Input only. SSH private key.
Note: The following fields are mutually exclusive: private_key, password. If a field in that set is populated, all other fields in the set will automatically be cleared.
Returns
(::String) — Input only. SSH private key.
Note: The following fields are mutually exclusive: private_key, password. If a field in that set is populated, all other fields in the set will automatically be cleared.
#username
defusername()->::String
Returns
(::String) — Required. Username for the SSH tunnel.
#username=
defusername=(value)->::String
Parameter
value (::String) — Required. Username for the SSH tunnel.
Returns
(::String) — Required. Username for the SSH tunnel.
[[["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::ForwardSshTunnelConnectivity (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-ForwardSshTunnelConnectivity)\n- [1.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.3.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [1.2.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.2.2/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [1.1.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.1.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [1.0.1](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.0.1/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.8.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.8.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.7.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.7.2/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.6.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.6.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.5.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.5.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.4.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.4.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.3.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.2.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.2.0/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity)\n- [0.1.5](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.1.5/Google-Cloud-CloudDMS-V1-ForwardSshTunnelConnectivity) \nReference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::ForwardSshTunnelConnectivity.\n\nForward SSH Tunnel connectivity. \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### #hostname\n\n def hostname() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Hostname for the SSH tunnel.\n\n### #hostname=\n\n def hostname=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Hostname for the SSH tunnel. \n**Returns**\n\n- (::String) --- Required. Hostname for the SSH tunnel.\n\n### #password\n\n def password() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Input only. SSH password.\n\n Note: The following fields are mutually exclusive: `password`, `private_key`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #password=\n\n def password=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Input only. SSH password.\n\n\nNote: The following fields are mutually exclusive: `password`, `private_key`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Input only. SSH password.\n\n Note: The following fields are mutually exclusive: `password`, `private_key`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #port\n\n def port() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Port for the SSH tunnel, default value is 22.\n\n### #port=\n\n def port=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Port for the SSH tunnel, default value is 22. \n**Returns**\n\n- (::Integer) --- Port for the SSH tunnel, default value is 22.\n\n### #private_key\n\n def private_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Input only. SSH private key.\n\n Note: The following fields are mutually exclusive: `private_key`, `password`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #private_key=\n\n def private_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Input only. SSH private key.\n\n\nNote: The following fields are mutually exclusive: `private_key`, `password`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- (::String) --- Input only. SSH private key.\n\n Note: The following fields are mutually exclusive: `private_key`, `password`. 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. Username for the SSH tunnel.\n\n### #username=\n\n def username=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Username for the SSH tunnel. \n**Returns**\n\n- (::String) --- Required. Username for the SSH tunnel."]]
