Google Cloud Edge Network V1 Client - Class Router (1.2.3)

Reference documentation and code samples for the Google Cloud Edge Network V1 Client class Router.

Message describing Router object

Generated from protobuf message google.cloud.edgenetwork.v1.Router

Namespace

Google \ Cloud \ EdgeNetwork \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Required. The canonical resource name of the router.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time when the router was created.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time when the router was last updated.

↳ labels
array| Google\Protobuf\Internal\MapField

Labels associated with this resource.

↳ description
string

Optional. A free-text description of the resource. Max length 1024 characters.

↳ network
string

Required. The canonical name of the network to which this router belongs. The name is in the form of projects/{project}/locations/{location}/zones/{zone}/networks/{network} .

↳ interface
array< Router\PBInterface >

Router interfaces.

↳ bgp_peer
array< Router\BgpPeer >

BGP peers.

↳ bgp
Router\Bgp

BGP information specific to this router.

↳ state
int

Output only. Current stage of the resource to the device by config push.

↳ route_advertisements
array

Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.

getName

Required. The canonical resource name of the router.

Returns
Type
Description
string

setName

Required. The canonical resource name of the router.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. The time when the router was created.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the router was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time when the router was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the router was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Labels associated with this resource.

Returns
Type
Description

setLabels

Labels associated with this resource.

Parameter
Name
Description
Returns
Type
Description
$this

getDescription

Optional. A free-text description of the resource. Max length 1024 characters.

Returns
Type
Description
string

setDescription

Optional. A free-text description of the resource. Max length 1024 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNetwork

Required. The canonical name of the network to which this router belongs.

The name is in the form of projects/{project}/locations/{location}/zones/{zone}/networks/{network} .

Returns
Type
Description
string

setNetwork

Required. The canonical name of the network to which this router belongs.

The name is in the form of projects/{project}/locations/{location}/zones/{zone}/networks/{network} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getInterface

Router interfaces.

Returns
Type
Description

setInterface

Router interfaces.

Parameter
Name
Description
var
Returns
Type
Description
$this

getBgpPeer

BGP peers.

Returns
Type
Description

setBgpPeer

BGP peers.

Parameter
Name
Description
var
array< Router\BgpPeer >
Returns
Type
Description
$this

getBgp

BGP information specific to this router.

Returns
Type
Description
Router\Bgp |null

hasBgp

clearBgp

setBgp

BGP information specific to this router.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. Current stage of the resource to the device by config push.

Returns
Type
Description
int

setState

Output only. Current stage of the resource to the device by config push.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getRouteAdvertisements

Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.

Returns
Type
Description

setRouteAdvertisements

Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.

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