Compute V1 Client - Class BfdPacket (1.7.1)

Version 1.7.1

• 1.19.0 (latest)
• 1.18.1
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

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

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ authentication_present	bool The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ control_plane_independent	bool The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ demand	bool The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ 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 Diagnostic enum for the list of possible values.
↳ final	bool The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ length	int The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880
↳ min_echo_rx_interval_ms	int The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880
↳ min_rx_interval_ms	int The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880
↳ min_tx_interval_ms	int The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880
↳ multiplier	int The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880
↳ multipoint	bool The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ my_discriminator	int The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880
↳ poll	bool The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880
↳ 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 State enum for the list of possible values.
↳ version	int The version number of the BFD protocol, as specified in section 4.1 of RFC5880.
↳ your_discriminator	int The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

getAuthenticationPresent

The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasAuthenticationPresent

clearAuthenticationPresent

setAuthenticationPresent

The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getControlPlaneIndependent

The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasControlPlaneIndependent

clearControlPlaneIndependent

setControlPlaneIndependent

The Control Plane Independent bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDemand

The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasDemand

clearDemand

setDemand

The demand bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDiagnostic

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 Diagnostic enum for the list of possible values.

Returns
Type	Description
string

hasDiagnostic

clearDiagnostic

setDiagnostic

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 Diagnostic enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFinal

The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasFinal

clearFinal

setFinal

The Final bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getLength

The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasLength

clearLength

setLength

The length of the BFD Control packet in bytes. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMinEchoRxIntervalMs

The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasMinEchoRxIntervalMs

clearMinEchoRxIntervalMs

setMinEchoRxIntervalMs

The Required Min Echo RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMinRxIntervalMs

The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasMinRxIntervalMs

clearMinRxIntervalMs

setMinRxIntervalMs

The Required Min RX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMinTxIntervalMs

The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasMinTxIntervalMs

clearMinTxIntervalMs

setMinTxIntervalMs

The Desired Min TX Interval value in the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMultiplier

The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasMultiplier

clearMultiplier

setMultiplier

The detection time multiplier of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getMultipoint

The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasMultipoint

clearMultipoint

setMultipoint

The multipoint bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getMyDiscriminator

The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasMyDiscriminator

clearMyDiscriminator

setMyDiscriminator

The My Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPoll

The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
bool

hasPoll

clearPoll

setPoll

The Poll bit of the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getState

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 Check the State enum for the list of possible values.

Returns
Type	Description
string

hasState

clearState

setState

The current BFD session state as seen by the transmitting system. These states are specified in section 4.1 of RFC5880 Check the State enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getVersion

The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

Returns
Type	Description
int

hasVersion

clearVersion

setVersion

The version number of the BFD protocol, as specified in section 4.1 of RFC5880.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getYourDiscriminator

The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

Returns
Type	Description
int

hasYourDiscriminator

clearYourDiscriminator

setYourDiscriminator

The Your Discriminator value in the BFD packet. This is specified in section 4.1 of RFC5880

Parameter
Name	Description
var	int

Returns
Type	Description
$this