Interface BfdParams

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BfdParams>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<HwvtepTunnelAttributes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<BfdParamsKey>

    @Generated("mdsal-binding-generator")
    public interface BfdParams
    extends org.opendaylight.yangtools.yang.binding.ChildOf<HwvtepTunnelAttributes>, org.opendaylight.yangtools.yang.binding.Augmentable<BfdParams>, org.opendaylight.yangtools.yang.binding.Identifiable<BfdParamsKey>
    Parameters to configure and enable BFD

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

     list bfd-params {
       key bfd-param-key;
       leaf bfd-param-key {
         type string;
       }
       leaf bfd-param-value {
         type string;
       }
     }
     

    To create instances of this class use BfdParamsBuilder.

    See Also:
    BfdParamsBuilder, BfdParamsKey
    • 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<BfdParams> 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 BfdParams 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 BfdParams 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 BfdParams 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
      • key

        BfdParamsKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<BfdParamsKey>
      • getBfdParamKey

        String getBfdParamKey()
        Return bfdParamKey, or null if it is not present.
             
                 bfd-param name/key
             
         
        Returns:
        String bfdParamKey, or null if it is not present.
      • requireBfdParamKey

        default @NonNull String requireBfdParamKey()
        Return bfdParamKey, guaranteed to be non-null.
             
                 bfd-param name/key
             
         
        Returns:
        String bfdParamKey, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bfdParamKey is not present
      • getBfdParamValue

        String getBfdParamValue()
        Return bfdParamValue, or null if it is not present.
             
                 bfd-param value
             
         
        Returns:
        String bfdParamValue, or null if it is not present.
      • requireBfdParamValue

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