Compute V1 Client - Class Router (1.19.0)

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

Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ bgp Google\Cloud\Compute\V1\RouterBgp

BGP information specific to this router.
↳ bgp_peers array<Google\Cloud\Compute\V1\RouterBgpPeer>

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this property when you create the resource.
↳ encrypted_interconnect_router bool

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
↳ id int|string

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ interfaces array<Google\Cloud\Compute\V1\RouterInterface>

Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.
↳ kind string

[Output Only] Type of resource. Always compute#router for routers.
↳ md5_authentication_keys array<Google\Cloud\Compute\V1\RouterMd5AuthenticationKey>

Keys used for MD5 authentication.
↳ name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ nats array<Google\Cloud\Compute\V1\RouterNat>

A list of NAT services created in this router.
↳ network string

URI of the network to which this router belongs.
↳ region string

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
↳ self_link string

[Output Only] Server-defined URL for the resource.

getBgp

BGP information specific to this router.

Returns
Type Description
Google\Cloud\Compute\V1\RouterBgp|null

hasBgp

clearBgp

setBgp

BGP information specific to this router.

Parameter
Name Description
var Google\Cloud\Compute\V1\RouterBgp
Returns
Type Description
$this

getBgpPeers

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setBgpPeers

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\RouterBgpPeer>
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEncryptedInterconnectRouter

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

Returns
Type Description
bool

hasEncryptedInterconnectRouter

clearEncryptedInterconnectRouter

setEncryptedInterconnectRouter

Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).

Parameter
Name Description
var bool
Returns
Type Description
$this

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getInterfaces

Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setInterfaces

Router interfaces. To create a BGP peer that uses a router interface, the interface must have one of the following fields specified: - linkedVpnTunnel - linkedInterconnectAttachment - subnetwork You can create a router interface without any of these fields specified. However, you cannot create a BGP peer that uses that interface.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\RouterInterface>
Returns
Type Description
$this

getKind

[Output Only] Type of resource. Always compute#router for routers.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#router for routers.

Parameter
Name Description
var string
Returns
Type Description
$this

getMd5AuthenticationKeys

Keys used for MD5 authentication.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMd5AuthenticationKeys

Keys used for MD5 authentication.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\RouterMd5AuthenticationKey>
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getNats

A list of NAT services created in this router.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNats

A list of NAT services created in this router.

Parameter
Name Description
var array<Google\Cloud\Compute\V1\RouterNat>
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

getRegion

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type Description
string

hasRegion

clearRegion

setRegion

[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this