Reference documentation and code samples for the Compute V1 Client class BfdStatus.
Next free: 15
Generated from protobuf messagegoogle.cloud.compute.v1.BfdStatus
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ bfd_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. Check the BfdSessionInitializationMode enum for the list of possible values.
Inter-packet time interval statistics for control packets.
↳ local_diagnostic
string
The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880 Check the LocalDiagnostic enum for the list of possible values.
↳ local_state
string
The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 Check the LocalState enum for the list of possible values.
The most recent Tx control packet for this BFD session.
↳ uptime_ms
int|string
Session uptime in milliseconds. Value will be 0 if session is not up.
getBfdSessionInitializationMode
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.
Check the BfdSessionInitializationMode enum for the list of possible values.
Returns
Type
Description
string
hasBfdSessionInitializationMode
clearBfdSessionInitializationMode
setBfdSessionInitializationMode
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.
Check the BfdSessionInitializationMode enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getConfigUpdateTimestampMicros
Unix timestamp of the most recent config update.
Returns
Type
Description
int|string
hasConfigUpdateTimestampMicros
clearConfigUpdateTimestampMicros
setConfigUpdateTimestampMicros
Unix timestamp of the most recent config update.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getControlPacketCounts
Control packet counts for the current BFD session.
The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880
Check the LocalDiagnostic enum for the list of possible values.
Returns
Type
Description
string
hasLocalDiagnostic
clearLocalDiagnostic
setLocalDiagnostic
The diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880
Check the LocalDiagnostic enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLocalState
The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880
Check the LocalState enum for the list of possible values.
Returns
Type
Description
string
hasLocalState
clearLocalState
setLocalState
The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880
Check the LocalState enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getNegotiatedLocalControlTxIntervalMs
Negotiated transmit interval for control packets.
Returns
Type
Description
int
hasNegotiatedLocalControlTxIntervalMs
clearNegotiatedLocalControlTxIntervalMs
setNegotiatedLocalControlTxIntervalMs
Negotiated transmit interval for control packets.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getRxPacket
The most recent Rx control packet for this BFD session.
[[["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-09-04 UTC."],[],[],null,["# Compute V1 Client - Class BfdStatus (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.BfdStatus)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.BfdStatus)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.BfdStatus)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.BfdStatus)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.BfdStatus)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.BfdStatus)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.BfdStatus)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.BfdStatus)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.BfdStatus)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.BfdStatus)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.BfdStatus)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.BfdStatus)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.BfdStatus)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.BfdStatus)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.BfdStatus)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.BfdStatus)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.BfdStatus)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.BfdStatus)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.BfdStatus)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.BfdStatus)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.BfdStatus)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.BfdStatus)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.BfdStatus)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.BfdStatus)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.BfdStatus)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.BfdStatus)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.BfdStatus)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.BfdStatus)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.BfdStatus)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.BfdStatus) \nReference documentation and code samples for the Compute V1 Client class BfdStatus.\n\nNext free: 15\n\nGenerated from protobuf message `google.cloud.compute.v1.BfdStatus`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBfdSessionInitializationMode\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.\n\nCheck the BfdSessionInitializationMode enum for the list of possible values.\n\n### hasBfdSessionInitializationMode\n\n### clearBfdSessionInitializationMode\n\n### setBfdSessionInitializationMode\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.\n\nCheck the BfdSessionInitializationMode enum for the list of possible values.\n\n### getConfigUpdateTimestampMicros\n\nUnix timestamp of the most recent config update.\n\n### hasConfigUpdateTimestampMicros\n\n### clearConfigUpdateTimestampMicros\n\n### setConfigUpdateTimestampMicros\n\nUnix timestamp of the most recent config update.\n\n### getControlPacketCounts\n\nControl packet counts for the current BFD session.\n\n### hasControlPacketCounts\n\n### clearControlPacketCounts\n\n### setControlPacketCounts\n\nControl packet counts for the current BFD session.\n\n### getControlPacketIntervals\n\nInter-packet time interval statistics for control packets.\n\n### setControlPacketIntervals\n\nInter-packet time interval statistics for control packets.\n\n### getLocalDiagnostic\n\nThe diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880\nCheck the LocalDiagnostic enum for the list of possible values.\n\n### hasLocalDiagnostic\n\n### clearLocalDiagnostic\n\n### setLocalDiagnostic\n\nThe diagnostic code specifies the local system's reason for the last change in session state. This allows remote systems to determine the reason that the previous session failed, for example. These diagnostic codes are specified in section 4.1 of RFC5880\nCheck the LocalDiagnostic enum for the list of possible values.\n\n### getLocalState\n\nThe current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880\nCheck the LocalState enum for the list of possible values.\n\n### hasLocalState\n\n### clearLocalState\n\n### setLocalState\n\nThe current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880\nCheck the LocalState enum for the list of possible values.\n\n### getNegotiatedLocalControlTxIntervalMs\n\nNegotiated transmit interval for control packets.\n\n### hasNegotiatedLocalControlTxIntervalMs\n\n### clearNegotiatedLocalControlTxIntervalMs\n\n### setNegotiatedLocalControlTxIntervalMs\n\nNegotiated transmit interval for control packets.\n\n### getRxPacket\n\nThe most recent Rx control packet for this BFD session.\n\n### hasRxPacket\n\n### clearRxPacket\n\n### setRxPacket\n\nThe most recent Rx control packet for this BFD session.\n\n### getTxPacket\n\nThe most recent Tx control packet for this BFD session.\n\n### hasTxPacket\n\n### clearTxPacket\n\n### setTxPacket\n\nThe most recent Tx control packet for this BFD session.\n\n### getUptimeMs\n\nSession uptime in milliseconds. Value will be 0 if session is not up.\n\n### hasUptimeMs\n\n### clearUptimeMs\n\n### setUptimeMs\n\nSession uptime in milliseconds. Value will be 0 if session is not up."]]
