Represents a Route.
Package
@google-cloud/network-connectivityConstructors
(constructor)(properties)
constructor(properties?: google.cloud.networkconnectivity.v1.IRoute);Constructs a new Route.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRoute
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Route createTime.
description
public description: string;Route description.
ipCidrRange
public ipCidrRange: string;Route ipCidrRange.
labels
public labels: { [k: string]: string };Route labels.
location
public location: string;Route location.
name
public name: string;Route name.
nextHopInterconnectAttachment
public nextHopInterconnectAttachment?: (google.cloud.networkconnectivity.v1.INextHopInterconnectAttachment|null);Route nextHopInterconnectAttachment.
nextHopRouterApplianceInstance
public nextHopRouterApplianceInstance?: (google.cloud.networkconnectivity.v1.INextHopRouterApplianceInstance|null);Route nextHopRouterApplianceInstance.
nextHopVpcNetwork
public nextHopVpcNetwork?: (google.cloud.networkconnectivity.v1.INextHopVpcNetwork|null);Route nextHopVpcNetwork.
nextHopVpnTunnel
public nextHopVpnTunnel?: (google.cloud.networkconnectivity.v1.INextHopVPNTunnel|null);Route nextHopVpnTunnel.
priority
public priority: (number|Long|string);Route priority.
spoke
public spoke: string;Route spoke.
state
public state: (google.cloud.networkconnectivity.v1.State|keyof typeof google.cloud.networkconnectivity.v1.State);Route state.
type
public type: (google.cloud.networkconnectivity.v1.RouteType|keyof typeof google.cloud.networkconnectivity.v1.RouteType);Route type.
uid
public uid: string;Route uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Route updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.networkconnectivity.v1.IRoute): google.cloud.networkconnectivity.v1.Route;Creates a new Route instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRoute
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Route |
Route instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1.Route;Decodes a Route 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 |
Route |
Route |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1.Route;Decodes a Route message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Route |
Route |
encode(message, writer)
public static encode(message: google.cloud.networkconnectivity.v1.IRoute, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Route message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRoute
Route 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.networkconnectivity.v1.IRoute, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Route message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRoute
Route 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.networkconnectivity.v1.Route;Creates a Route 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 |
Route |
Route |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Route
| 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 Route to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.networkconnectivity.v1.Route, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Route message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Route
Route |
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 Route message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|