# Distributed Cloud Edge Network V1 API - Class Google::Cloud::EdgeNetwork::V1::Router (v2.6.0)

2.6.0 (latest) 2.5.0 2.4.0 2.3.1 2.2.0 2.1.0 2.0.2 1.2.0 1.1.0 1.0.3 0.5.0 0.4.1 0.3.1 0.2.1 0.1.0 Reference documentation and code samples for the Distributed Cloud Edge Network V1 API class Google::Cloud::EdgeNetwork::V1::Router.

Message describing Router object

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #bgp

    def bgp() -> ::Google::Cloud::EdgeNetwork::V1::Router::Bgp

**Returns**

- ([::Google::Cloud::EdgeNetwork::V1::Router::Bgp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Bgp)) --- BGP information specific to this router.

### #bgp=

    def bgp=(value) -> ::Google::Cloud::EdgeNetwork::V1::Router::Bgp

**Parameter**

- **value** ([::Google::Cloud::EdgeNetwork::V1::Router::Bgp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Bgp)) --- BGP information specific to this router.
**Returns**

- ([::Google::Cloud::EdgeNetwork::V1::Router::Bgp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Bgp)) --- BGP information specific to this router.

### #bgp_peer

    def bgp_peer() -> ::Array<::Google::Cloud::EdgeNetwork::V1::Router::BgpPeer>

**Returns**

- (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::BgpPeer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-BgpPeer)\>) --- BGP peers.

### #bgp_peer=

    def bgp_peer=(value) -> ::Array<::Google::Cloud::EdgeNetwork::V1::Router::BgpPeer>

**Parameter**

- **value** (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::BgpPeer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-BgpPeer)\>) --- BGP peers.
**Returns**

- (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::BgpPeer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-BgpPeer)\>) --- BGP peers.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Protobuf-Timestamp)) --- Output only. The time when the router was created.

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. A free-text description of the resource. Max length 1024 characters.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. A free-text description of the resource. Max length 1024 characters.
**Returns**

- (::String) --- Optional. A free-text description of the resource. Max length 1024 characters.

### #interface

    def interface() -> ::Array<::Google::Cloud::EdgeNetwork::V1::Router::Interface>

**Returns**

- (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::Interface](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Interface)\>) --- Router interfaces.

### #interface=

    def interface=(value) -> ::Array<::Google::Cloud::EdgeNetwork::V1::Router::Interface>

**Parameter**

- **value** (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::Interface](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Interface)\>) --- Router interfaces.
**Returns**

- (::Array\<[::Google::Cloud::EdgeNetwork::V1::Router::Interface](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-Router-Interface)\>) --- Router interfaces.

### #labels

    def labels() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Labels associated with this resource.

### #labels=

    def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- Labels associated with this resource.
**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- Labels associated with this resource.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Required. The canonical resource name of the router.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The canonical resource name of the router.
**Returns**

- (::String) --- Required. The canonical resource name of the router.

### #network

    def network() -> ::String

**Returns**

- (::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}`.

### #network=

    def network=(value) -> ::String

**Parameter**

- **value** (::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}`.
**Returns**

- (::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}`.

### #route_advertisements

    def route_advertisements() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.

### #route_advertisements=

    def route_advertisements=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.
**Returns**

- (::Array\<::String\>) --- Optional. A list of CIDRs in IP/Length format to advertise northbound as static routes from this router.

### #state

    def state() -> ::Google::Cloud::EdgeNetwork::V1::ResourceState

**Returns**

- ([::Google::Cloud::EdgeNetwork::V1::ResourceState](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Cloud-EdgeNetwork-V1-ResourceState)) --- Output only. Current stage of the resource to the device by config push.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-edge_network-v1/latest/Google-Protobuf-Timestamp)) --- Output only. The time when the router was last updated.