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.
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.
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.
[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.
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.
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.
[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.
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.
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.
[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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class Router (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.Router)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.Router)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.Router)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.Router)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.Router)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.Router)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.Router)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.Router)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.Router)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.Router)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.Router)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.Router)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.Router)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.Router)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.Router)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.Router)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.Router)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.Router)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.Router)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.Router)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.Router)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.Router)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.Router)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.Router)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.Router)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.Router)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.Router)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.Router)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.Router)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.Router) \nReference documentation and code samples for the Compute V1 Client class Router.\n\nRepresents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview.\n\nGenerated from protobuf message `google.cloud.compute.v1.Router`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBgp\n\nBGP information specific to this router.\n\n### hasBgp\n\n### clearBgp\n\n### setBgp\n\nBGP information specific to this router.\n\n### getBgpPeers\n\nBGP 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.\n\n### setBgpPeers\n\nBGP 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.\n\n### getCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### hasCreationTimestamp\n\n### clearCreationTimestamp\n\n### setCreationTimestamp\n\n\\[Output Only\\] Creation timestamp in RFC3339 text format.\n\n### getDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nAn optional description of this resource. Provide this property when you create the resource.\n\n### getEncryptedInterconnectRouter\n\nIndicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).\n\n### hasEncryptedInterconnectRouter\n\n### clearEncryptedInterconnectRouter\n\n### setEncryptedInterconnectRouter\n\nIndicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).\n\n### getId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### hasId\n\n### clearId\n\n### setId\n\n\\[Output Only\\] The unique identifier for the resource. This identifier is defined by the server.\n\n### getInterfaces\n\nRouter 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.\n\n### setInterfaces\n\nRouter 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.\n\n### getKind\n\n\\[Output Only\\] Type of resource. Always compute#router for routers.\n\n### hasKind\n\n### clearKind\n\n### setKind\n\n\\[Output Only\\] Type of resource. Always compute#router for routers.\n\n### getMd5AuthenticationKeys\n\nKeys used for MD5 authentication.\n\n### setMd5AuthenticationKeys\n\nKeys used for MD5 authentication.\n\n### getName\n\nName 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.\n\n### hasName\n\n### clearName\n\n### setName\n\nName 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.\n\n### getNats\n\nA list of NAT services created in this router.\n\n### setNats\n\nA list of NAT services created in this router.\n\n### getNetwork\n\nURI of the network to which this router belongs.\n\n### hasNetwork\n\n### clearNetwork\n\n### setNetwork\n\nURI of the network to which this router belongs.\n\n### getRegion\n\n\\[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.\n\n### hasRegion\n\n### clearRegion\n\n### setRegion\n\n\\[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.\n\n### getSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource.\n\n### hasSelfLink\n\n### clearSelfLink\n\n### setSelfLink\n\n\\[Output Only\\] Server-defined URL for the resource."]]
