Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes

Interface InterfaceBfdStatus

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<InterfaceBfdStatus>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<InterfaceBfdStatusKey>
    @Generated("mdsal-binding-generator")
public interface InterfaceBfdStatus
extends org.opendaylight.yangtools.yang.binding.ChildOf<OvsdbPortInterfaceAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<InterfaceBfdStatus>, org.opendaylight.yangtools.yang.binding.Identifiable<InterfaceBfdStatusKey>
    BFD status for a particular interface. The switch sets key-value pairs in the bfd_status column to report the status of BFD on this interface. When BFD is enabled, with bfd:enable, the switch clears all key-value pairs from bfd_status : state: optional string, one of [admin_down, down, init, up] the state of the BFD session. The BFD session is fully healthy and negotiated UP. bfd_status : forwarding: optional string, true or false Reports whether the BFD session believes this Interface may be used to forward traffic. Typically this means the local session is signaling UP, and the remote system isn't signaling a problem such as concatenated path down. bfd_status : diagnostic: optional string A diagnostic code specifying the local system's reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status : remote_state: optional string, one of [admin_down, down, init, up] Reports the state of the remote endpoint's BFD session. bfd_status : remote_diagnostic: optional string A diagnostic code specifying remote system's reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status : flap_count: optional string, containing an integer, minimum 0 Counts the number of bfd_status:forwarding flaps since start. A flap is considered as a change of bfd_status:forwarding value.

    This class represents the following YANG schema fragment defined in module ovsdb 

     list interface-bfd-status {
   key bfd-status-key;
   leaf bfd-status-key {
     type string;
   }
   leaf bfd-status-value {
     type string;
   }
 }

    To create instances of this class use InterfaceBfdStatusBuilder.

    See Also:
    InterfaceBfdStatusBuilder, InterfaceBfdStatusKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        default Class<InterfaceBfdStatus> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull InterfaceBfdStatus obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull InterfaceBfdStatus thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull InterfaceBfdStatus obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • getBfdStatusKey

        String getBfdStatusKey()
        Return bfdStatusKey, or null if it is not present. 
             
         bfd-status name/key
        Returns:
        String bfdStatusKey, or null if it is not present.

      • requireBfdStatusKey

        default @NonNull String requireBfdStatusKey()
        Return bfdStatusKey, guaranteed to be non-null. 
             
         bfd-status name/key
        Returns:
        String bfdStatusKey, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bfdStatusKey is not present

      • getBfdStatusValue

        String getBfdStatusValue()
        Return bfdStatusValue, or null if it is not present. 
             
         bfd-status value
        Returns:
        String bfdStatusValue, or null if it is not present.

      • requireBfdStatusValue

        default @NonNull String requireBfdStatusValue()
        Return bfdStatusValue, guaranteed to be non-null. 
             
         bfd-status value
        Returns:
        String bfdStatusValue, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bfdStatusValue is not present