Reference documentation and code samples for the Compute V1 Client class RouterBgpPeerBfd.
Generated from protobuf message google.cloud.compute.v1.RouterBgpPeerBfd
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ min_receive_interval
int
The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
↳ min_transmit_interval
int
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
↳ multiplier
int
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.
↳ session_initialization_mode
string
The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. Check the SessionInitializationMode enum for the list of possible values.
getMinReceiveInterval
The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
Returns
Type
Description
int
hasMinReceiveInterval
clearMinReceiveInterval
setMinReceiveInterval
The minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMinTransmitInterval
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
Returns
Type
Description
int
hasMinTransmitInterval
clearMinTransmitInterval
setMinTransmitInterval
The minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMultiplier
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.
Returns
Type
Description
int
hasMultiplier
clearMultiplier
setMultiplier
The number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getSessionInitializationMode
The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
Check the SessionInitializationMode enum for the list of possible values.
Returns
Type
Description
string
hasSessionInitializationMode
clearSessionInitializationMode
setSessionInitializationMode
The BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
Check the SessionInitializationMode enum for the list of possible values.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class RouterBgpPeerBfd (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.RouterBgpPeerBfd)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.RouterBgpPeerBfd)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.RouterBgpPeerBfd)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.RouterBgpPeerBfd)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.RouterBgpPeerBfd)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.RouterBgpPeerBfd)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.RouterBgpPeerBfd)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.RouterBgpPeerBfd)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.RouterBgpPeerBfd)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.RouterBgpPeerBfd)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.RouterBgpPeerBfd)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.RouterBgpPeerBfd)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.RouterBgpPeerBfd)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.RouterBgpPeerBfd)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.RouterBgpPeerBfd)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.RouterBgpPeerBfd)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.RouterBgpPeerBfd)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.RouterBgpPeerBfd)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.RouterBgpPeerBfd)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.RouterBgpPeerBfd)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.RouterBgpPeerBfd)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.RouterBgpPeerBfd)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.RouterBgpPeerBfd)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.RouterBgpPeerBfd)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.RouterBgpPeerBfd)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.RouterBgpPeerBfd)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.RouterBgpPeerBfd)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.RouterBgpPeerBfd)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.RouterBgpPeerBfd)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.RouterBgpPeerBfd) \nReference documentation and code samples for the Compute V1 Client class RouterBgpPeerBfd.\n\nGenerated from protobuf message `google.cloud.compute.v1.RouterBgpPeerBfd`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMinReceiveInterval\n\nThe minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.\n\n### hasMinReceiveInterval\n\n### clearMinReceiveInterval\n\n### setMinReceiveInterval\n\nThe minimum interval, in milliseconds, between BFD control packets received from the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the transmit interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.\n\n### getMinTransmitInterval\n\nThe minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.\n\n### hasMinTransmitInterval\n\n### clearMinTransmitInterval\n\n### setMinTransmitInterval\n\nThe minimum interval, in milliseconds, between BFD control packets transmitted to the peer router. The actual value is negotiated between the two routers and is equal to the greater of this value and the corresponding receive interval of the other router. If set, this value must be between 1000 and 30000. The default is 1000.\n\n### getMultiplier\n\nThe number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.\n\n### hasMultiplier\n\n### clearMultiplier\n\n### setMultiplier\n\nThe number of consecutive BFD packets that must be missed before BFD declares that a peer is unavailable. If set, the value must be a value between 5 and 16. The default is 5.\n\n### getSessionInitializationMode\n\nThe BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.\n\nCheck the SessionInitializationMode enum for the list of possible values.\n\n### hasSessionInitializationMode\n\n### clearSessionInitializationMode\n\n### setSessionInitializationMode\n\nThe BFD session initialization mode for this BGP peer. If set to ACTIVE, the Cloud Router will initiate the BFD session for this BGP peer. If set to PASSIVE, the Cloud Router will wait for the peer router to initiate the BFD session for this BGP peer. If set to DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.\n\nCheck the SessionInitializationMode enum for the list of possible values."]]