Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206

Interface NetconfSessionEnd

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NetconfSessionEnd>, org.opendaylight.yangtools.yang.binding.BaseNotification, org.opendaylight.yangtools.yang.binding.BindingObject, CommonSessionParms, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Notification
    @Generated("mdsal-binding-generator")
public interface NetconfSessionEnd
extends org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Augmentable<NetconfSessionEnd>, CommonSessionParms, org.opendaylight.yangtools.yang.binding.Notification
    Generated when a NETCONF server detects that a NETCONF session has terminated. server MAY optionally generate this event for non-NETCONF management sessions. Indicates the identity of the user that owned the session, and why the session was terminated.

    This class represents the following YANG schema fragment defined in module ietf-netconf-notifications 

     notification netconf-session-end {
   uses common-session-parms;
   leaf killed-by {
     when "../termination-reason = 'killed'";
     type nc:session-id-type;
   }
   leaf termination-reason {
     type enumeration {
       enum closed {
       }
       enum killed {
       }
       enum dropped {
       }
       enum timeout {
       }
       enum bad-hello {
       }
       enum other {
       }
     }
   }
 }
    The schema path to identify an instance is ietf-netconf-notifications/netconf-session-end

    To create instances of this class use NetconfSessionEndBuilder.

    See Also:
    NetconfSessionEndBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<NetconfSessionEnd> implementedInterface()
        Specified by:
        implementedInterface in interface CommonSessionParms
        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 NetconfSessionEnd 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 NetconfSessionEnd 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 NetconfSessionEnd 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

      • getKilledBy

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType getKilledBy()
        Return killedBy, or null if it is not present. 
             
         The ID of the session that directly caused this session to be abnormally
         terminated. If this session was abnormally terminated by a non-NETCONF session
         unknown to the server, then this leaf will not be present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType killedBy, or null if it is not present.

      • getTerminationReason

        NetconfSessionEnd.TerminationReason getTerminationReason()
        Return terminationReason, or null if it is not present. 
             
         Reason the session was terminated.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfSessionEnd.TerminationReason terminationReason, or null if it is not present.