Compute V1 Client - Class RouterStatusBgpPeerStatus (1.18.0)

Reference documentation and code samples for the Compute V1 Client class RouterStatusBgpPeerStatus.

Generated from protobuf message google.cloud.compute.v1.RouterStatusBgpPeerStatus

Namespace

Google \ Cloud \ Compute \ V1

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_ipv4 bool

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.
↳ enable_ipv6 bool

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.
↳ ip_address string

IP address of the local BGP interface.
↳ ipv4_nexthop_address string

IPv4 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_ipv4_nexthop_address string

IPv4 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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAdvertisedRoutes

Routes that were advertised to the remote BGP peer

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

getEnableIpv4

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

Returns
Type Description
bool

hasEnableIpv4

clearEnableIpv4

setEnableIpv4

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEnableIpv6

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

Returns
Type Description
bool

hasEnableIpv6

clearEnableIpv6

setEnableIpv6

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

Parameter
Name Description
var bool
Returns
Type Description
$this

getIpAddress

IP address of the local BGP interface.

Returns
Type Description
string

hasIpAddress

clearIpAddress

setIpAddress

IP address of the local BGP interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpv4NexthopAddress

IPv4 address of the local BGP interface.

Returns
Type Description
string

hasIpv4NexthopAddress

clearIpv4NexthopAddress

setIpv4NexthopAddress

IPv4 address of the local BGP interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpv6NexthopAddress

IPv6 address of the local BGP interface.

Returns
Type Description
string

hasIpv6NexthopAddress

clearIpv6NexthopAddress

setIpv6NexthopAddress

IPv6 address of the local BGP interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getLinkedVpnTunnel

URL of the VPN tunnel that this BGP peer controls.

Returns
Type Description
string

hasLinkedVpnTunnel

clearLinkedVpnTunnel

setLinkedVpnTunnel

URL of the VPN tunnel that this BGP peer controls.

Parameter
Name Description
var string
Returns
Type Description
$this

getMd5AuthEnabled

Informs whether MD5 authentication is enabled on this BGP peer.

Returns
Type Description
bool

hasMd5AuthEnabled

clearMd5AuthEnabled

setMd5AuthEnabled

Informs whether MD5 authentication is enabled on this BGP peer.

Parameter
Name Description
var bool
Returns
Type Description
$this

getName

Name of this BGP peer. Unique within the Routers resource.

Returns
Type Description
string

hasName

clearName

setName

Name of this BGP peer. Unique within the Routers resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getNumLearnedRoutes

Number of routes learned from the remote BGP Peer.

Returns
Type Description
int

hasNumLearnedRoutes

clearNumLearnedRoutes

setNumLearnedRoutes

Number of routes learned from the remote BGP Peer.

Parameter
Name Description
var int
Returns
Type Description
$this

getPeerIpAddress

IP address of the remote BGP interface.

Returns
Type Description
string

hasPeerIpAddress

clearPeerIpAddress

setPeerIpAddress

IP address of the remote BGP interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeerIpv4NexthopAddress

IPv4 address of the remote BGP interface.

Returns
Type Description
string

hasPeerIpv4NexthopAddress

clearPeerIpv4NexthopAddress

setPeerIpv4NexthopAddress

IPv4 address of the remote BGP interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getPeerIpv6NexthopAddress

IPv6 address of the remote BGP interface.

Returns
Type Description
string

hasPeerIpv6NexthopAddress

clearPeerIpv6NexthopAddress

setPeerIpv6NexthopAddress

IPv6 address of the remote BGP interface.

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.

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.

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.

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.

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.

Returns
Type Description
string

hasStatus

clearStatus

setStatus

Status of the BGP peer: {UP, DOWN} Check the Status enum for the list of possible values.

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.

Returns
Type Description
string

hasStatusReason

clearStatusReason

setStatusReason

Indicates why particular status was returned.

Check the StatusReason enum for the list of possible values.

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getUptimeSeconds

Time this session has been up, in seconds. Format: 145

Returns
Type Description
string

hasUptimeSeconds

clearUptimeSeconds

setUptimeSeconds

Time this session has been up, in seconds. Format: 145

Parameter
Name Description
var string
Returns
Type Description
$this