Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp

Interface GracefulRestart

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<GracefulRestart>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Bgp>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    @Generated("mdsal-binding-generator")
public interface GracefulRestart
extends org.opendaylight.yangtools.yang.binding.ChildOf<Bgp>, org.opendaylight.yangtools.yang.binding.Augmentable<GracefulRestart>
    Controls the BGP graceful restart capability.

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

     container graceful-restart {
   leaf enable {
     type boolean;
   }
   leaf restart-time {
     type uint16 {
       range 1..3600;
     }
     default 120;
   }
   leaf stalepath-time {
     type uint16 {
       range 5..3600;
     }
     default 360;
   }
 }
    The schema path to identify an instance is bgp/bgp-router/af-configuration/ipv4/unicast/bgp/graceful-restart

    To create instances of this class use GracefulRestartBuilder.

    See Also:
    GracefulRestartBuilder

    • Field Summary

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

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<GracefulRestart> 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 GracefulRestart 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 GracefulRestart 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 GracefulRestart 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

      • getEnable

        java.lang.Boolean getEnable()
        Return enable, or null if it is not present.
        Returns:
        java.lang.Boolean enable, or null if it is not present.

      • isEnable

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

      • getRestartTime

        org.opendaylight.yangtools.yang.common.Uint16 getRestartTime()
        Return restartTime, or null if it is not present. 
             
         Sets the maximum time period (in seconds) that the local router will wait for a
         graceful-restart-capable neighbor to return to normal operation after a restart
         event occurs.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 restartTime, or null if it is not present.

      • getStalepathTime

        org.opendaylight.yangtools.yang.common.Uint16 getStalepathTime()
        Return stalepathTime, or null if it is not present. 
             
         Sets the maximum time period that the local router will hold stale paths for a
         restarting peer.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 stalepathTime, or null if it is not present.