Reference documentation and code samples for the Compute V1 Client class RouterStatusBgpPeerStatus.
Generated from protobuf message google.cloud.compute.v1.RouterStatusBgpPeerStatus
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ advertised_routes |
array<Google\Cloud\Compute\V1\Route>
Routes that were advertised to the remote BGP peer |
↳ bfd_status |
Google\Cloud\Compute\V1\BfdStatus
|
↳ enable_ipv6 |
bool
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. |
↳ ip_address |
string
IP address of the local BGP interface. |
↳ ipv6_nexthop_address |
string
IPv6 address of the local BGP interface. |
↳ linked_vpn_tunnel |
string
URL of the VPN tunnel that this BGP peer controls. |
↳ md5_auth_enabled |
bool
Informs whether MD5 authentication is enabled on this BGP peer. |
↳ name |
string
Name of this BGP peer. Unique within the Routers resource. |
↳ num_learned_routes |
int
Number of routes learned from the remote BGP Peer. |
↳ peer_ip_address |
string
IP address of the remote BGP interface. |
↳ peer_ipv6_nexthop_address |
string
IPv6 address of the remote BGP interface. |
↳ router_appliance_instance |
string
[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session. |
↳ state |
string
The state of the BGP session. For a list of possible values for this field, see BGP session states. |
↳ status |
string
Status of the BGP peer: {UP, DOWN} Check the Status enum for the list of possible values. |
↳ status_reason |
string
Indicates why particular status was returned. Check the StatusReason enum for the list of possible values. |
↳ uptime |
string
Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds |
↳ uptime_seconds |
string
Time this session has been up, in seconds. Format: 145 |
getAdvertisedRoutes
Routes that were advertised to the remote BGP peer
Generated from protobuf field repeated .google.cloud.compute.v1.Route advertised_routes = 333393068;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAdvertisedRoutes
Routes that were advertised to the remote BGP peer
Generated from protobuf field repeated .google.cloud.compute.v1.Route advertised_routes = 333393068;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\Route>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBfdStatus
Generated from protobuf field optional .google.cloud.compute.v1.BfdStatus bfd_status = 395631729;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\BfdStatus|null | |
hasBfdStatus
clearBfdStatus
setBfdStatus
Generated from protobuf field optional .google.cloud.compute.v1.BfdStatus bfd_status = 395631729;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\BfdStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableIpv6
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
Generated from protobuf field optional bool enable_ipv6 = 181467939;
| Returns | |
|---|---|
| Type | Description |
bool | |
hasEnableIpv6
clearEnableIpv6
setEnableIpv6
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
Generated from protobuf field optional bool enable_ipv6 = 181467939;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpAddress
IP address of the local BGP interface.
Generated from protobuf field optional string ip_address = 406272220;
| Returns | |
|---|---|
| Type | Description |
string | |
hasIpAddress
clearIpAddress
setIpAddress
IP address of the local BGP interface.
Generated from protobuf field optional string ip_address = 406272220;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIpv6NexthopAddress
IPv6 address of the local BGP interface.
Generated from protobuf field optional string ipv6_nexthop_address = 27968211;
| Returns | |
|---|---|
| Type | Description |
string | |
hasIpv6NexthopAddress
clearIpv6NexthopAddress
setIpv6NexthopAddress
IPv6 address of the local BGP interface.
Generated from protobuf field optional string ipv6_nexthop_address = 27968211;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLinkedVpnTunnel
URL of the VPN tunnel that this BGP peer controls.
Generated from protobuf field optional string linked_vpn_tunnel = 352296953;
| Returns | |
|---|---|
| Type | Description |
string | |
hasLinkedVpnTunnel
clearLinkedVpnTunnel
setLinkedVpnTunnel
URL of the VPN tunnel that this BGP peer controls.
Generated from protobuf field optional string linked_vpn_tunnel = 352296953;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMd5AuthEnabled
Informs whether MD5 authentication is enabled on this BGP peer.
Generated from protobuf field optional bool md5_auth_enabled = 451152075;
| Returns | |
|---|---|
| Type | Description |
bool | |
hasMd5AuthEnabled
clearMd5AuthEnabled
setMd5AuthEnabled
Informs whether MD5 authentication is enabled on this BGP peer.
Generated from protobuf field optional bool md5_auth_enabled = 451152075;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Name of this BGP peer. Unique within the Routers resource.
Generated from protobuf field optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
Name of this BGP peer. Unique within the Routers resource.
Generated from protobuf field optional string name = 3373707;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNumLearnedRoutes
Number of routes learned from the remote BGP Peer.
Generated from protobuf field optional uint32 num_learned_routes = 135457535;
| Returns | |
|---|---|
| Type | Description |
int | |
hasNumLearnedRoutes
clearNumLearnedRoutes
setNumLearnedRoutes
Number of routes learned from the remote BGP Peer.
Generated from protobuf field optional uint32 num_learned_routes = 135457535;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPeerIpAddress
IP address of the remote BGP interface.
Generated from protobuf field optional string peer_ip_address = 207735769;
| Returns | |
|---|---|
| Type | Description |
string | |
hasPeerIpAddress
clearPeerIpAddress
setPeerIpAddress
IP address of the remote BGP interface.
Generated from protobuf field optional string peer_ip_address = 207735769;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPeerIpv6NexthopAddress
IPv6 address of the remote BGP interface.
Generated from protobuf field optional string peer_ipv6_nexthop_address = 491486608;
| Returns | |
|---|---|
| Type | Description |
string | |
hasPeerIpv6NexthopAddress
clearPeerIpv6NexthopAddress
setPeerIpv6NexthopAddress
IPv6 address of the remote BGP interface.
Generated from protobuf field optional string peer_ipv6_nexthop_address = 491486608;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRouterApplianceInstance
[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.
Generated from protobuf field optional string router_appliance_instance = 468312989;
| Returns | |
|---|---|
| Type | Description |
string | |
hasRouterApplianceInstance
clearRouterApplianceInstance
setRouterApplianceInstance
[Output only] URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance is the peer side of the BGP session.
Generated from protobuf field optional string router_appliance_instance = 468312989;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The state of the BGP session. For a list of possible values for this field, see BGP session states.
Generated from protobuf field optional string state = 109757585;
| Returns | |
|---|---|
| Type | Description |
string | |
hasState
clearState
setState
The state of the BGP session. For a list of possible values for this field, see BGP session states.
Generated from protobuf field optional string state = 109757585;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatus
Status of the BGP peer: {UP, DOWN} Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatus
clearStatus
setStatus
Status of the BGP peer: {UP, DOWN} Check the Status enum for the list of possible values.
Generated from protobuf field optional string status = 181260274;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStatusReason
Indicates why particular status was returned.
Check the StatusReason enum for the list of possible values.
Generated from protobuf field optional string status_reason = 342706993;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStatusReason
clearStatusReason
setStatusReason
Indicates why particular status was returned.
Check the StatusReason enum for the list of possible values.
Generated from protobuf field optional string status_reason = 342706993;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUptime
Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
Generated from protobuf field optional string uptime = 235379688;
| Returns | |
|---|---|
| Type | Description |
string | |
hasUptime
clearUptime
setUptime
Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds
Generated from protobuf field optional string uptime = 235379688;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUptimeSeconds
Time this session has been up, in seconds. Format: 145
Generated from protobuf field optional string uptime_seconds = 104736040;
| Returns | |
|---|---|
| Type | Description |
string | |
hasUptimeSeconds
clearUptimeSeconds
setUptimeSeconds
Time this session has been up, in seconds. Format: 145
Generated from protobuf field optional string uptime_seconds = 104736040;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |