Router

google.cloud.compute.v1. Router

Represents a Router.

Constructor

new Router(propertiesopt)

Constructs a new Router.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IRouter <optional>

Properties to set

Implements:
  • IRouter

Members

_bgp

Router _bgp.

_creationTimestamp

Router _creationTimestamp.

_description

Router _description.

_encryptedInterconnectRouter

Router _encryptedInterconnectRouter.

_id

Router _id.

_kind

Router _kind.

_name

Router _name.

_network

Router _network.

_region

Router _region.

Router _selfLink.

bgp

Router bgp.

bgpPeers

Router bgpPeers.

creationTimestamp

Router creationTimestamp.

description

Router description.

encryptedInterconnectRouter

Router encryptedInterconnectRouter.

id

Router id.

interfaces

Router interfaces.

kind

Router kind.

md5AuthenticationKeys

Router md5AuthenticationKeys.

name

Router name.

nats

Router nats.

network

Router network.

region

Router region.

Router selfLink.

Methods

toJSON() → {Object.<string, *>}

Converts this Router to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.Router}

Creates a new Router instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IRouter <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.Router

Router instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.Router}

Decodes a Router message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.Router

Router

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.Router}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.Router

Router

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Router message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IRouter

Router message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IRouter

Router message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.Router}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.Router

Router

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Router

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.Router

Router

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Router message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not