Represents a Route.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IRoute);Constructs a new Route.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRoute
Properties to set |
Properties
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Route _creationTimestamp.
_description
public _description?: "description";Route _description.
_destRange
public _destRange?: "destRange";Route _destRange.
_id
public _id?: "id";Route _id.
_kind
public _kind?: "kind";Route _kind.
_name
public _name?: "name";Route _name.
_network
public _network?: "network";Route _network.
_nextHopGateway
public _nextHopGateway?: "nextHopGateway";Route _nextHopGateway.
_nextHopHub
public _nextHopHub?: "nextHopHub";Route _nextHopHub.
_nextHopIlb
public _nextHopIlb?: "nextHopIlb";Route _nextHopIlb.
_nextHopInstance
public _nextHopInstance?: "nextHopInstance";Route _nextHopInstance.
_nextHopIp
public _nextHopIp?: "nextHopIp";Route _nextHopIp.
_nextHopNetwork
public _nextHopNetwork?: "nextHopNetwork";Route _nextHopNetwork.
_nextHopPeering
public _nextHopPeering?: "nextHopPeering";Route _nextHopPeering.
_nextHopVpnTunnel
public _nextHopVpnTunnel?: "nextHopVpnTunnel";Route _nextHopVpnTunnel.
_priority
public _priority?: "priority";Route _priority.
_routeStatus
public _routeStatus?: "routeStatus";Route _routeStatus.
_routeType
public _routeType?: "routeType";Route _routeType.
_selfLink
public _selfLink?: "selfLink";Route _selfLink.
asPaths
public asPaths: google.cloud.compute.v1.IRouteAsPath[];Route asPaths.
creationTimestamp
public creationTimestamp?: (string|null);Route creationTimestamp.
description
public description?: (string|null);Route description.
destRange
public destRange?: (string|null);Route destRange.
id
public id?: (number|Long|string|null);Route id.
kind
public kind?: (string|null);Route kind.
name
public name?: (string|null);Route name.
network
public network?: (string|null);Route network.
nextHopGateway
public nextHopGateway?: (string|null);Route nextHopGateway.
nextHopHub
public nextHopHub?: (string|null);Route nextHopHub.
nextHopIlb
public nextHopIlb?: (string|null);Route nextHopIlb.
nextHopInstance
public nextHopInstance?: (string|null);Route nextHopInstance.
nextHopIp
public nextHopIp?: (string|null);Route nextHopIp.
nextHopNetwork
public nextHopNetwork?: (string|null);Route nextHopNetwork.
nextHopPeering
public nextHopPeering?: (string|null);Route nextHopPeering.
nextHopVpnTunnel
public nextHopVpnTunnel?: (string|null);Route nextHopVpnTunnel.
priority
public priority?: (number|null);Route priority.
routeStatus
public routeStatus?: (string|null);Route routeStatus.
routeType
public routeType?: (string|null);Route routeType.
selfLink
public selfLink?: (string|null);Route selfLink.
tags
public tags: string[];Route tags.
warnings
public warnings: google.cloud.compute.v1.IWarnings[];Route warnings.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IRoute): google.cloud.compute.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.compute.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.compute.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.compute.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.compute.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.compute.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.compute.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) |
|