Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Router.
Represents a Cloud Router resource.
For more information about Cloud Router, read theCloud Router overview.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bgp
def bgp() -> ::Google::Cloud::Compute::V1::RouterBgp
Returns
- (::Google::Cloud::Compute::V1::RouterBgp) — BGP information specific to this router.
#bgp=
def bgp=(value) -> ::Google::Cloud::Compute::V1::RouterBgp
Parameter
- value (::Google::Cloud::Compute::V1::RouterBgp) — BGP information specific to this router.
Returns
- (::Google::Cloud::Compute::V1::RouterBgp) — BGP information specific to this router.
#bgp_peers
def bgp_peers() -> ::Array<::Google::Cloud::Compute::V1::RouterBgpPeer>
Returns
- (::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 toRFC4273.
#bgp_peers=
def bgp_peers=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterBgpPeer>
Parameter
- value (::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 toRFC4273.
Returns
- (::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 toRFC4273.
#creation_timestamp
def creation_timestamp() -> ::String
Returns
- (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
- (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
#description
def description() -> ::String
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#encrypted_interconnect_router
def encrypted_interconnect_router() -> ::Boolean
Returns
- (::Boolean) — Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
#encrypted_interconnect_router=
def encrypted_interconnect_router=(value) -> ::Boolean
Parameter
- value (::Boolean) — Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
Returns
- (::Boolean) — Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments).
#id
def id() -> ::Integer
Returns
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#id=
def id=(value) -> ::Integer
Parameter
- value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#interfaces
def interfaces() -> ::Array<::Google::Cloud::Compute::V1::RouterInterface>
Returns
-
(::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.
#interfaces=
def interfaces=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterInterface>
Parameter
-
value (::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.
Returns
-
(::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
def kind() -> ::String
Returns
- (::String) — Output only. [Output Only] Type of resource. Always compute#router for routers.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — Output only. [Output Only] Type of resource. Always compute#router for routers.
Returns
- (::String) — Output only. [Output Only] Type of resource. Always compute#router for routers.
#md5_authentication_keys
def md5_authentication_keys() -> ::Array<::Google::Cloud::Compute::V1::RouterMd5AuthenticationKey>
Returns
- (::Array<::Google::Cloud::Compute::V1::RouterMd5AuthenticationKey>) — Keys used for MD5 authentication.
#md5_authentication_keys=
def md5_authentication_keys=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterMd5AuthenticationKey>
Parameter
- value (::Array<::Google::Cloud::Compute::V1::RouterMd5AuthenticationKey>) — Keys used for MD5 authentication.
Returns
- (::Array<::Google::Cloud::Compute::V1::RouterMd5AuthenticationKey>) — Keys used for MD5 authentication.
#name
def name() -> ::String
Returns
-
(::String) — Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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
-
(::String) — Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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
def nats() -> ::Array<::Google::Cloud::Compute::V1::RouterNat>
Returns
- (::Array<::Google::Cloud::Compute::V1::RouterNat>) — A list of NAT services created in this router.
#nats=
def nats=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterNat>
Parameter
- value (::Array<::Google::Cloud::Compute::V1::RouterNat>) — A list of NAT services created in this router.
Returns
- (::Array<::Google::Cloud::Compute::V1::RouterNat>) — A list of NAT services created in this router.
#network
def network() -> ::String
Returns
- (::String) — URI of the network to which this router belongs.
#network=
def network=(value) -> ::String
Parameter
- value (::String) — URI of the network to which this router belongs.
Returns
- (::String) — URI of the network to which this router belongs.
#params
def params() -> ::Google::Cloud::Compute::V1::RouterParams
Returns
- (::Google::Cloud::Compute::V1::RouterParams) — Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
#params=
def params=(value) -> ::Google::Cloud::Compute::V1::RouterParams
Parameter
- value (::Google::Cloud::Compute::V1::RouterParams) — Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
Returns
- (::Google::Cloud::Compute::V1::RouterParams) — Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
#region
def region() -> ::String
Returns
- (::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.
#region=
def region=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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
def self_link() -> ::String
Returns
- (::String) — [Output Only] Server-defined URL for the resource.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — [Output Only] Server-defined URL for the resource.
Returns
- (::String) — [Output Only] Server-defined URL for the resource.