Compute V1 Client - Class RouterStatus (1.25.0)

Reference documentation and code samples for the Compute V1 Client class RouterStatus.

Generated from protobuf message google.cloud.compute.v1.RouterStatus

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ best_routes
array< Route >

A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions.

↳ best_routes_for_router
array< Route >

A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router.

↳ bgp_peer_status
↳ nat_status
↳ network
string

URI of the network to which this router belongs.

getBestRoutes

A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions.

Returns
Type
Description

setBestRoutes

A list of the best dynamic routes for this Cloud Router's Virtual Private Cloud (VPC) network in the same region as this Cloud Router. Lists all of the best routes per prefix that are programmed into this region's VPC data plane. When global dynamic routing mode is turned on in the VPC network, this list can include cross-region dynamic routes from Cloud Routers in other regions.

Parameter
Name
Description
var
array< Route >
Returns
Type
Description
$this

getBestRoutesForRouter

A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router.

Returns
Type
Description

setBestRoutesForRouter

A list of the best BGP routes learned by this Cloud Router. It is possible that routes listed might not be programmed into the data plane, if the Google Cloud control plane finds a more optimal route for a prefix than a route learned by this Cloud Router.

Parameter
Name
Description
var
array< Route >
Returns
Type
Description
$this

getBgpPeerStatus

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusBgpPeerStatus bgp_peer_status = 218459131;

Returns
Type
Description

setBgpPeerStatus

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusBgpPeerStatus bgp_peer_status = 218459131;

Parameter
Name
Description
Returns
Type
Description
$this

getNatStatus

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusNatStatus nat_status = 63098064;

Returns
Type
Description

setNatStatus

Generated from protobuf field repeated .google.cloud.compute.v1.RouterStatusNatStatus nat_status = 63098064;

Parameter
Name
Description
var
Returns
Type
Description
$this

getNetwork

URI of the network to which this router belongs.

Returns
Type
Description
string

hasNetwork

clearNetwork

setNetwork

URI of the network to which this router belongs.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: