Compute V1 Client - Class BfdPacket (1.6.1)

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
NameDescription
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
TypeDescription
bool

hasAuthenticationPresent

clearAuthenticationPresent

setAuthenticationPresent

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getControlPlaneIndependent

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

Returns
TypeDescription
bool

hasControlPlaneIndependent

clearControlPlaneIndependent

setControlPlaneIndependent

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDemand

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

Returns
TypeDescription
bool

hasDemand

clearDemand

setDemand

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getFinal

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

Returns
TypeDescription
bool

hasFinal

clearFinal

setFinal

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getLength

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

Returns
TypeDescription
int

hasLength

clearLength

setLength

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMinEchoRxIntervalMs

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

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

getMinRxIntervalMs

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

Returns
TypeDescription
int

hasMinRxIntervalMs

clearMinRxIntervalMs

setMinRxIntervalMs

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMinTxIntervalMs

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

Returns
TypeDescription
int

hasMinTxIntervalMs

clearMinTxIntervalMs

setMinTxIntervalMs

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMultiplier

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

Returns
TypeDescription
int

hasMultiplier

clearMultiplier

setMultiplier

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getMultipoint

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

Returns
TypeDescription
bool

hasMultipoint

clearMultipoint

setMultipoint

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getMyDiscriminator

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

Returns
TypeDescription
int

hasMyDiscriminator

clearMyDiscriminator

setMyDiscriminator

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPoll

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

Returns
TypeDescription
bool

hasPoll

clearPoll

setPoll

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getVersion

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

Returns
TypeDescription
int

hasVersion

clearVersion

setVersion

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getYourDiscriminator

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

Returns
TypeDescription
int

hasYourDiscriminator

clearYourDiscriminator

setYourDiscriminator

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this