Class protos.google.cloud.compute.v1.VpnGateway (4.1.0)

Represents a VpnGateway.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new VpnGateway.

Parameter
NameDescription
properties IVpnGateway

Properties to set

Properties

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

VpnGateway _creationTimestamp.

_description

public _description?: "description";

VpnGateway _description.

_id

public _id?: "id";

VpnGateway _id.

_kind

public _kind?: "kind";

VpnGateway _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

VpnGateway _labelFingerprint.

_name

public _name?: "name";

VpnGateway _name.

_network

public _network?: "network";

VpnGateway _network.

_region

public _region?: "region";

VpnGateway _region.

public _selfLink?: "selfLink";

VpnGateway _selfLink.

_stackType

public _stackType?: "stackType";

VpnGateway _stackType.

creationTimestamp

public creationTimestamp?: (string|null);

VpnGateway creationTimestamp.

description

public description?: (string|null);

VpnGateway description.

id

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

VpnGateway id.

kind

public kind?: (string|null);

VpnGateway kind.

labelFingerprint

public labelFingerprint?: (string|null);

VpnGateway labelFingerprint.

labels

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

VpnGateway labels.

name

public name?: (string|null);

VpnGateway name.

network

public network?: (string|null);

VpnGateway network.

region

public region?: (string|null);

VpnGateway region.

public selfLink?: (string|null);

VpnGateway selfLink.

stackType

public stackType?: (string|null);

VpnGateway stackType.

vpnInterfaces

public vpnInterfaces: google.cloud.compute.v1.IVpnGatewayVpnGatewayInterface[];

VpnGateway vpnInterfaces.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IVpnGateway): google.cloud.compute.v1.VpnGateway;

Creates a new VpnGateway instance using the specified properties.

Parameter
NameDescription
properties IVpnGateway

Properties to set

Returns
TypeDescription
VpnGateway

VpnGateway instance

decode(reader, length)

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

Decodes a VpnGateway message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
VpnGateway

VpnGateway

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
VpnGateway

VpnGateway

encode(message, writer)

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

Encodes the specified VpnGateway message. Does not implicitly messages.

Parameters
NameDescription
message IVpnGateway

VpnGateway message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IVpnGateway

VpnGateway message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
VpnGateway

VpnGateway

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for VpnGateway

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this VpnGateway to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message VpnGateway

VpnGateway

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a VpnGateway message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not