Class protos.google.cloud.compute.v1.VpnTunnel (4.6.0)

Represents a VpnTunnel.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IVpnTunnel);

Constructs a new VpnTunnel.

Parameter
Name Description
properties IVpnTunnel

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

VpnTunnel _creationTimestamp.

_description

public _description?: "description";

VpnTunnel _description.

_detailedStatus

public _detailedStatus?: "detailedStatus";

VpnTunnel _detailedStatus.

_id

public _id?: "id";

VpnTunnel _id.

_ikeVersion

public _ikeVersion?: "ikeVersion";

VpnTunnel _ikeVersion.

_kind

public _kind?: "kind";

VpnTunnel _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

VpnTunnel _labelFingerprint.

_name

public _name?: "name";

VpnTunnel _name.

_peerExternalGateway

public _peerExternalGateway?: "peerExternalGateway";

VpnTunnel _peerExternalGateway.

_peerExternalGatewayInterface

public _peerExternalGatewayInterface?: "peerExternalGatewayInterface";

VpnTunnel _peerExternalGatewayInterface.

_peerGcpGateway

public _peerGcpGateway?: "peerGcpGateway";

VpnTunnel _peerGcpGateway.

_peerIp

public _peerIp?: "peerIp";

VpnTunnel _peerIp.

_region

public _region?: "region";

VpnTunnel _region.

_router

public _router?: "router";

VpnTunnel _router.

_selfLink

public _selfLink?: "selfLink";

VpnTunnel _selfLink.

_sharedSecret

public _sharedSecret?: "sharedSecret";

VpnTunnel _sharedSecret.

_sharedSecretHash

public _sharedSecretHash?: "sharedSecretHash";

VpnTunnel _sharedSecretHash.

_status

public _status?: "status";

VpnTunnel _status.

_targetVpnGateway

public _targetVpnGateway?: "targetVpnGateway";

VpnTunnel _targetVpnGateway.

_vpnGateway

public _vpnGateway?: "vpnGateway";

VpnTunnel _vpnGateway.

_vpnGatewayInterface

public _vpnGatewayInterface?: "vpnGatewayInterface";

VpnTunnel _vpnGatewayInterface.

creationTimestamp

public creationTimestamp?: (string|null);

VpnTunnel creationTimestamp.

description

public description?: (string|null);

VpnTunnel description.

detailedStatus

public detailedStatus?: (string|null);

VpnTunnel detailedStatus.

id

public id?: (number|Long|string|null);

VpnTunnel id.

ikeVersion

public ikeVersion?: (number|null);

VpnTunnel ikeVersion.

kind

public kind?: (string|null);

VpnTunnel kind.

labelFingerprint

public labelFingerprint?: (string|null);

VpnTunnel labelFingerprint.

labels

public labels: { [k: string]: string };

VpnTunnel labels.

localTrafficSelector

public localTrafficSelector: string[];

VpnTunnel localTrafficSelector.

name

public name?: (string|null);

VpnTunnel name.

peerExternalGateway

public peerExternalGateway?: (string|null);

VpnTunnel peerExternalGateway.

peerExternalGatewayInterface

public peerExternalGatewayInterface?: (number|null);

VpnTunnel peerExternalGatewayInterface.

peerGcpGateway

public peerGcpGateway?: (string|null);

VpnTunnel peerGcpGateway.

peerIp

public peerIp?: (string|null);

VpnTunnel peerIp.

region

public region?: (string|null);

VpnTunnel region.

remoteTrafficSelector

public remoteTrafficSelector: string[];

VpnTunnel remoteTrafficSelector.

router

public router?: (string|null);

VpnTunnel router.

selfLink

public selfLink?: (string|null);

VpnTunnel selfLink.

sharedSecret

public sharedSecret?: (string|null);

VpnTunnel sharedSecret.

sharedSecretHash

public sharedSecretHash?: (string|null);

VpnTunnel sharedSecretHash.

status

public status?: (string|null);

VpnTunnel status.

targetVpnGateway

public targetVpnGateway?: (string|null);

VpnTunnel targetVpnGateway.

vpnGateway

public vpnGateway?: (string|null);

VpnTunnel vpnGateway.

vpnGatewayInterface

public vpnGatewayInterface?: (number|null);

VpnTunnel vpnGatewayInterface.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IVpnTunnel): google.cloud.compute.v1.VpnTunnel;

Creates a new VpnTunnel instance using the specified properties.

Parameter
Name Description
properties IVpnTunnel

Properties to set
Returns
Type Description
VpnTunnel

VpnTunnel instance

decode(reader, length)

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

Decodes a VpnTunnel message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
VpnTunnel

VpnTunnel

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
VpnTunnel

VpnTunnel

encode(message, writer)

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

Encodes the specified VpnTunnel message. Does not implicitly messages.

Parameters
Name Description
message IVpnTunnel

VpnTunnel 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.compute.v1.IVpnTunnel, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IVpnTunnel

VpnTunnel 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.compute.v1.VpnTunnel;

Creates a VpnTunnel 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
VpnTunnel

VpnTunnel

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for VpnTunnel

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 VpnTunnel to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message VpnTunnel

VpnTunnel
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 VpnTunnel 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