Reference documentation and code samples for the Google Cloud Dms V1 Client class ReverseSshConnectivity.
The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC.
Generated from protobuf message google.cloud.clouddms.v1.ReverseSshConnectivity
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ vm_ip |
string
Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. |
↳ vm_port |
int
Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. |
↳ vm |
string
The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel. |
↳ vpc |
string
The name of the VPC to peer with the Cloud SQL private network. |
getVmIp
Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Returns | |
|---|---|
| Type | Description |
string | |
setVmIp
Required. The IP of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVmPort
Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Returns | |
|---|---|
| Type | Description |
int | |
setVmPort
Required. The forwarding port of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVm
The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Returns | |
|---|---|
| Type | Description |
string | |
setVm
The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVpc
The name of the VPC to peer with the Cloud SQL private network.
| Returns | |
|---|---|
| Type | Description |
string | |
setVpc
The name of the VPC to peer with the Cloud SQL private network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |