Google Cloud Datastream V1 Client - Class ForwardSshTunnelConnectivity (1.0.5)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setHostname

Required. Hostname for the SSH tunnel.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUsername

Required. Username for the SSH tunnel.

Returns
TypeDescription
string

setUsername

Required. Username for the SSH tunnel.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPort

Port for the SSH tunnel, default value is 22.

Returns
TypeDescription
int

setPort

Port for the SSH tunnel, default value is 22.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPassword

Input only. SSH password.

Returns
TypeDescription
string

hasPassword

setPassword

Input only. SSH password.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPrivateKey

Input only. SSH private key.

Returns
TypeDescription
string

hasPrivateKey

setPrivateKey

Input only. SSH private key.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAuthenticationMethod

Returns
TypeDescription
string