Route

google.cloud.networkconnectivity.v1. Route

Represents a Route.

Constructor

new Route(propertiesopt)

Constructs a new Route.

Parameters:
Name Type Attributes Description
properties google.cloud.networkconnectivity.v1.IRoute <optional>

Properties to set

Implements:
  • IRoute

Members

createTime

Route createTime.

description

Route description.

ipCidrRange

Route ipCidrRange.

labels

Route labels.

location

Route location.

name

Route name.

nextHopVpcNetwork

Route nextHopVpcNetwork.

spoke

Route spoke.

state

Route state.

type

Route type.

uid

Route uid.

updateTime

Route updateTime.

Methods

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

Converts this Route to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.networkconnectivity.v1.Route}

Creates a new Route instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.networkconnectivity.v1.IRoute <optional>

Properties to set

Returns:
Type Description
google.cloud.networkconnectivity.v1.Route

Route instance

(static) decode(reader, lengthopt) → {google.cloud.networkconnectivity.v1.Route}

Decodes a Route 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.networkconnectivity.v1.Route

Route

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.networkconnectivity.v1.Route}

Decodes a Route 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.networkconnectivity.v1.Route

Route

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 Route message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.networkconnectivity.v1.IRoute

Route 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 Route message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.networkconnectivity.v1.IRoute

Route 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.networkconnectivity.v1.Route}

Creates a Route 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.networkconnectivity.v1.Route

Route

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Route

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 Route message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.networkconnectivity.v1.Route

Route

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Route 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