Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.datastream.v1.ForwardSshTunnelConnectivity (2.1.2)

Represents a ForwardSshTunnelConnectivity.

Package

@google-cloud/datastream

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1.IForwardSshTunnelConnectivity);

Constructs a new ForwardSshTunnelConnectivity.

Parameter

Name	Description
properties	`IForwardSshTunnelConnectivity` Properties to set

Properties

authenticationMethod

public authenticationMethod?: ("password"|"privateKey");

ForwardSshTunnelConnectivity authenticationMethod.

hostname

public hostname: string;

ForwardSshTunnelConnectivity hostname.

password

public password?: (string|null);

ForwardSshTunnelConnectivity password.

port

public port: number;

ForwardSshTunnelConnectivity port.

privateKey

public privateKey?: (string|null);

ForwardSshTunnelConnectivity privateKey.

username

public username: string;

ForwardSshTunnelConnectivity username.

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1.IForwardSshTunnelConnectivity): google.cloud.datastream.v1.ForwardSshTunnelConnectivity;

Creates a new ForwardSshTunnelConnectivity instance using the specified properties.

Parameter

Name	Description
properties	`IForwardSshTunnelConnectivity` Properties to set

Returns

Type	Description
google.cloud.datastream.v1.ForwardSshTunnelConnectivity	ForwardSshTunnelConnectivity instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1.ForwardSshTunnelConnectivity;

Decodes a ForwardSshTunnelConnectivity message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.datastream.v1.ForwardSshTunnelConnectivity	ForwardSshTunnelConnectivity

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1.ForwardSshTunnelConnectivity;

Decodes a ForwardSshTunnelConnectivity message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.datastream.v1.ForwardSshTunnelConnectivity	ForwardSshTunnelConnectivity

encode(message, writer)

public static encode(message: google.cloud.datastream.v1.IForwardSshTunnelConnectivity, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ForwardSshTunnelConnectivity message. Does not implicitly messages.

Parameters

Name	Description
message	`IForwardSshTunnelConnectivity` ForwardSshTunnelConnectivity message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datastream.v1.IForwardSshTunnelConnectivity, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ForwardSshTunnelConnectivity message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IForwardSshTunnelConnectivity` ForwardSshTunnelConnectivity message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datastream.v1.ForwardSshTunnelConnectivity;

Creates a ForwardSshTunnelConnectivity message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.datastream.v1.ForwardSshTunnelConnectivity	ForwardSshTunnelConnectivity

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ForwardSshTunnelConnectivity

Parameter

Name	Description
typeUrlPrefix	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
string	The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this ForwardSshTunnelConnectivity to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.datastream.v1.ForwardSshTunnelConnectivity, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ForwardSshTunnelConnectivity message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.datastream.v1.ForwardSshTunnelConnectivity` ForwardSshTunnelConnectivity
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ForwardSshTunnelConnectivity message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not