Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebfd.rev190219

Interface BfdConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BfdConfig>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BfdData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface BfdConfig
extends org.opendaylight.yangtools.yang.binding.ChildOf<BfdData>, org.opendaylight.yangtools.yang.binding.Augmentable<BfdConfig>

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

     container bfd-config {
   leaf bfd-enabled {
     type boolean;
     default false;
   }
   leaf detect-mult {
     type uint32;
     default 3;
   }
   leaf min-rx {
     type uint32 {
       range 50..50000;
     }
     default 500;
   }
   leaf min-tx {
     type uint32 {
       range "1000 .. 60000";
     }
     default 6000;
   }
   leaf multihop {
     type boolean;
     default true;
   }
 }
    The schema path to identify an instance is bfd/bfd-config

    To create instances of this class use BfdConfigBuilder.

    See Also:
    BfdConfigBuilder

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull BfdConfig thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull BfdConfig obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull BfdConfig obj)
      Default implementation of Object.toString() contract for this interface.
      java.lang.Boolean getBfdEnabled()
      Return bfdEnabled, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getDetectMult()
      Return detectMult, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getMinRx()
      Return minRx, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getMinTx()
      Return minTx, or null if it is not present.
      java.lang.Boolean getMultihop()
      Return multihop, or null if it is not present.
      default java.lang.Class<BfdConfig> implementedInterface()  
      default java.lang.Boolean isBfdEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      default java.lang.Boolean isMultihop()
      Deprecated, for removal: This API element is subject to removal in a future version.

      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default java.lang.Class<BfdConfig> 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 BfdConfig 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:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull BfdConfig thisObj,
                             java.lang.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:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull BfdConfig 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:
        java.lang.NullPointerException - if obj is null

      • getBfdEnabled

        java.lang.Boolean getBfdEnabled()
        Return bfdEnabled, or null if it is not present. 
             
         is BFD enabled
        Returns:
        java.lang.Boolean bfdEnabled, or null if it is not present.

      • isBfdEnabled

        @Deprecated(forRemoval=true)
default java.lang.Boolean isBfdEnabled()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getDetectMult

        org.opendaylight.yangtools.yang.common.Uint32 getDetectMult()
        Return detectMult, or null if it is not present. 
             
         The number of packets that have to be missed in a row to declare the session to
         be down.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 detectMult, or null if it is not present.

      • getMinRx

        org.opendaylight.yangtools.yang.common.Uint32 getMinRx()
        Return minRx, or null if it is not present. 
             
         The shortest interval, in milli-seconds, at which this BFD session offers to
         receive BFD control messages. Defaults to 500
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 minRx, or null if it is not present.

      • getMinTx

        org.opendaylight.yangtools.yang.common.Uint32 getMinTx()
        Return minTx, or null if it is not present. 
             
         The shortest interval, in milli-seconds, at which this BFD session is willing to
         transmit BFD control messages. Defaults to 6000
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 minTx, or null if it is not present.

      • getMultihop

        java.lang.Boolean getMultihop()
        Return multihop, or null if it is not present. 
             
         Value of True indicates suppport for BFD multihop
        Returns:
        java.lang.Boolean multihop, or null if it is not present.

      • isMultihop

        @Deprecated(forRemoval=true)
default java.lang.Boolean isMultihop()
        Deprecated, for removal: This API element is subject to removal in a future version.