Compute V1 Client - Class RouterBgpPeerBfd (1.6.1)

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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this