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

Interface NetconfConfirmedCommit

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NetconfConfirmedCommit>, 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 NetconfConfirmedCommit
extends org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Augmentable<NetconfConfirmedCommit>, CommonSessionParms, org.opendaylight.yangtools.yang.binding.Notification
    Generated when a NETCONF server detects that a confirmed-commit event has occurred. Indicates the event and the current state of the confirmed-commit procedure in progress.

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

     notification netconf-confirmed-commit {
   uses common-session-parms {
     when "confirm-event != 'timeout'";
   }
   leaf confirm-event {
     type enumeration {
       enum start {
       }
       enum cancel {
       }
       enum timeout {
       }
       enum extend {
       }
       enum complete {
       }
     }
   }
   leaf timeout {
     when "../confirm-event = 'start' or ../confirm-event = 'extend'";
     type uint32;
     units seconds;
   }
 }
    The schema path to identify an instance is ietf-netconf-notifications/netconf-confirmed-commit

    To create instances of this class use NetconfConfirmedCommitBuilder.

    See Also:
    NetconfConfirmedCommitBuilder

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<NetconfConfirmedCommit> 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 NetconfConfirmedCommit 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 NetconfConfirmedCommit 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 NetconfConfirmedCommit 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

      • getConfirmEvent

        NetconfConfirmedCommit.ConfirmEvent getConfirmEvent()
        Return confirmEvent, or null if it is not present. 
             
         Indicates the event that caused the notification.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfirmedCommit.ConfirmEvent confirmEvent, or null if it is not present.

      • getTimeout

        org.opendaylight.yangtools.yang.common.Uint32 getTimeout()
        Return timeout, or null if it is not present. 
             
         The configured timeout value if the event type is 'start' or 'extend'. This
         value represents the approximate number of seconds from the event time when the
         'timeout' event might occur.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 timeout, or null if it is not present.