Console
    Contact Us Start free

    Compute V1 Client - Class BfdStatus (1.5.0)

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

    Next free: 15

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

    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.

    ↳ config_update_timestamp_micros
    int|string

    Unix timestamp of the most recent config update.

    ↳ control_packet_counts
    Google\Cloud\Compute\V1\BfdStatusPacketCounts

    Control packet counts for the current BFD session.

    ↳ control_packet_intervals
    array< Google\Cloud\Compute\V1\PacketIntervals >

    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.

    ↳ negotiated_local_control_tx_interval_ms
    int

    Negotiated transmit interval for control packets.

    ↳ rx_packet
    Google\Cloud\Compute\V1\BfdPacket

    The most recent Rx control packet for this BFD session.

    ↳ tx_packet
    Google\Cloud\Compute\V1\BfdPacket

    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.

    Generated from protobuf field optional string bfd_session_initialization_mode = 218156954;

    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.

    Generated from protobuf field optional string bfd_session_initialization_mode = 218156954;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getConfigUpdateTimestampMicros

    Unix timestamp of the most recent config update.

    Generated from protobuf field optional int64 config_update_timestamp_micros = 457195569;

    Returns
    Type
    Description
    int|string

    hasConfigUpdateTimestampMicros

    clearConfigUpdateTimestampMicros

    setConfigUpdateTimestampMicros

    Unix timestamp of the most recent config update.

    Generated from protobuf field optional int64 config_update_timestamp_micros = 457195569;

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this

    getControlPacketCounts

    Control packet counts for the current BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdStatusPacketCounts control_packet_counts = 132573561;

    Returns
    Type
    Description
    Google\Cloud\Compute\V1\BfdStatusPacketCounts |null

    hasControlPacketCounts

    clearControlPacketCounts

    setControlPacketCounts

    Control packet counts for the current BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdStatusPacketCounts control_packet_counts = 132573561;

    Parameter
    Name
    Description
    var
    Google\Cloud\Compute\V1\BfdStatusPacketCounts
    Returns
    Type
    Description
    $this

    getControlPacketIntervals

    Inter-packet time interval statistics for control packets.

    Generated from protobuf field repeated .google.cloud.compute.v1.PacketIntervals control_packet_intervals = 500806649;

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setControlPacketIntervals

    Inter-packet time interval statistics for control packets.

    Generated from protobuf field repeated .google.cloud.compute.v1.PacketIntervals control_packet_intervals = 500806649;

    Parameter
    Name
    Description
    var
    array< Google\Cloud\Compute\V1\PacketIntervals >
    Returns
    Type
    Description
    $this

    getLocalDiagnostic

    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.

    Generated from protobuf field optional string local_diagnostic = 463737083;

    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.

    Generated from protobuf field optional string local_diagnostic = 463737083;

    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.

    Generated from protobuf field optional string local_state = 149195453;

    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.

    Generated from protobuf field optional string local_state = 149195453;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getNegotiatedLocalControlTxIntervalMs

    Negotiated transmit interval for control packets.

    Generated from protobuf field optional uint32 negotiated_local_control_tx_interval_ms = 21768340;

    Returns
    Type
    Description
    int

    hasNegotiatedLocalControlTxIntervalMs

    clearNegotiatedLocalControlTxIntervalMs

    setNegotiatedLocalControlTxIntervalMs

    Negotiated transmit interval for control packets.

    Generated from protobuf field optional uint32 negotiated_local_control_tx_interval_ms = 21768340;

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getRxPacket

    The most recent Rx control packet for this BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdPacket rx_packet = 505069729;

    Returns
    Type
    Description
    Google\Cloud\Compute\V1\BfdPacket |null

    hasRxPacket

    clearRxPacket

    setRxPacket

    The most recent Rx control packet for this BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdPacket rx_packet = 505069729;

    Parameter
    Name
    Description
    var
    Google\Cloud\Compute\V1\BfdPacket
    Returns
    Type
    Description
    $this

    getTxPacket

    The most recent Tx control packet for this BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdPacket tx_packet = 111386275;

    Returns
    Type
    Description
    Google\Cloud\Compute\V1\BfdPacket |null

    hasTxPacket

    clearTxPacket

    setTxPacket

    The most recent Tx control packet for this BFD session.

    Generated from protobuf field optional .google.cloud.compute.v1.BfdPacket tx_packet = 111386275;

    Parameter
    Name
    Description
    var
    Google\Cloud\Compute\V1\BfdPacket
    Returns
    Type
    Description
    $this

    getUptimeMs

    Session uptime in milliseconds. Value will be 0 if session is not up.

    Generated from protobuf field optional int64 uptime_ms = 125398365;

    Returns
    Type
    Description
    int|string

    hasUptimeMs

    clearUptimeMs

    setUptimeMs

    Session uptime in milliseconds. Value will be 0 if session is not up.

    Generated from protobuf field optional int64 uptime_ms = 125398365;

    Parameter
    Name
    Description
    var
    int|string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: