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
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ bgp
↳ 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. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
↳ kind
string
[Output Only] Type of resource. Always compute#router for routers.
↳ md5_authentication_keys
↳ 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
↳ 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.
hasBgp
clearBgp
setBgp
BGP information specific to this router.
$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.
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.
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getEncryptedInterconnectRouter
Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
bool
hasEncryptedInterconnectRouter
clearEncryptedInterconnectRouter
setEncryptedInterconnectRouter
Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
var
bool
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
var
int|string
$this
getInterfaces
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
setInterfaces
Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.
$this
getKind
[Output Only] Type of resource. Always compute#router for routers.
string
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#router for routers.
var
string
$this
getMd5AuthenticationKeys
Keys used for MD5 authentication.
setMd5AuthenticationKeys
Keys used for MD5 authentication.
$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.
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.
var
string
$this
getNats
A list of NAT services created in this router.
setNats
A list of NAT services created in this router.
$this
getNetwork
URI of the network to which this router belongs.
string
hasNetwork
clearNetwork
setNetwork
URI of the network to which this router belongs.
var
string
$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.
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.
var
string
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
var
string
$this
