Class protos.google.cloud.compute.v1.Router (4.3.0)

Represents a Router.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Router.

Parameter
NameDescription
properties IRouter

Properties to set

Properties

_bgp

public _bgp?: "bgp";

Router _bgp.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Router _creationTimestamp.

_description

public _description?: "description";

Router _description.

_encryptedInterconnectRouter

public _encryptedInterconnectRouter?: "encryptedInterconnectRouter";

Router _encryptedInterconnectRouter.

_id

public _id?: "id";

Router _id.

_kind

public _kind?: "kind";

Router _kind.

_name

public _name?: "name";

Router _name.

_network

public _network?: "network";

Router _network.

_region

public _region?: "region";

Router _region.

public _selfLink?: "selfLink";

Router _selfLink.

bgp

public bgp?: (google.cloud.compute.v1.IRouterBgp|null);

Router bgp.

bgpPeers

public bgpPeers: google.cloud.compute.v1.IRouterBgpPeer[];

Router bgpPeers.

creationTimestamp

public creationTimestamp?: (string|null);

Router creationTimestamp.

description

public description?: (string|null);

Router description.

encryptedInterconnectRouter

public encryptedInterconnectRouter?: (boolean|null);

Router encryptedInterconnectRouter.

id

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

Router id.

interfaces

public interfaces: google.cloud.compute.v1.IRouterInterface[];

Router interfaces.

kind

public kind?: (string|null);

Router kind.

md5AuthenticationKeys

public md5AuthenticationKeys: google.cloud.compute.v1.IRouterMd5AuthenticationKey[];

Router md5AuthenticationKeys.

name

public name?: (string|null);

Router name.

nats

public nats: google.cloud.compute.v1.IRouterNat[];

Router nats.

network

public network?: (string|null);

Router network.

region

public region?: (string|null);

Router region.

public selfLink?: (string|null);

Router selfLink.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IRouter): google.cloud.compute.v1.Router;

Creates a new Router instance using the specified properties.

Parameter
NameDescription
properties IRouter

Properties to set

Returns
TypeDescription
Router

Router instance

decode(reader, length)

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

Decodes a Router 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
Router

Router

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Router

Router

encode(message, writer)

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

Encodes the specified Router message. Does not implicitly messages.

Parameters
NameDescription
message IRouter

Router 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.IRouter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IRouter

Router 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.Router;

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

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

Plain object

Returns
TypeDescription
Router

Router

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Router

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Router

Router

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