Reference documentation and code samples for the Google Cloud Datastream V1 Client class ForwardSshTunnelConnectivity.
Forward SSH Tunnel connectivity.
Generated from protobuf message google.cloud.datastream.v1.ForwardSshTunnelConnectivity
Namespace
Google \ Cloud \ Datastream \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ hostname |
string
Required. Hostname for the SSH tunnel. |
↳ username |
string
Required. Username for the SSH tunnel. |
↳ port |
int
Port for the SSH tunnel, default value is 22. |
↳ password |
string
Input only. SSH password. |
↳ private_key |
string
Input only. SSH private key. |
getHostname
Required. Hostname for the SSH tunnel.
| Returns | |
|---|---|
| Type | Description |
string | |
setHostname
Required. Hostname for the SSH tunnel.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUsername
Required. Username for the SSH tunnel.
| Returns | |
|---|---|
| Type | Description |
string | |
setUsername
Required. Username for the SSH tunnel.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPort
Port for the SSH tunnel, default value is 22.
| Returns | |
|---|---|
| Type | Description |
int | |
setPort
Port for the SSH tunnel, default value is 22.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPassword
Input only. SSH password.
| Returns | |
|---|---|
| Type | Description |
string | |
hasPassword
setPassword
Input only. SSH password.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPrivateKey
Input only. SSH private key.
| Returns | |
|---|---|
| Type | Description |
string | |
hasPrivateKey
setPrivateKey
Input only. SSH private key.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthenticationMethod
| Returns | |
|---|---|
| Type | Description |
string | |