Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state

Interface Messages

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Messages>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PcepSessionState>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, ErrorMessagesGrouping, ReplyTimeGrouping
@Generated("mdsal-binding-generator") public interface Messages extends org.opendaylight.yangtools.yang.binding.ChildOf<PcepSessionState>, org.opendaylight.yangtools.yang.binding.Augmentable<Messages>, ReplyTimeGrouping, ErrorMessagesGrouping
The statistics of PCEP received/sent messages from the PCE point of view.

This class represents the following YANG schema fragment defined in module pcep-session-stats 

 container messages {
   uses reply-time-grouping;
   leaf received-msg-count {
     type uint32;
     default 0;
   }
   leaf sent-msg-count {
     type uint32;
     default 0;
   }
   leaf last-sent-msg-timestamp {
     type uint32;
     default 0;
   }
   leaf unknown-msg-received {
     type uint16;
     default 0;
   }
   uses error-messages-grouping;
 }

To create instances of this class use MessagesBuilder.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull Messages thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Messages obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Messages obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yangtools.yang.common.Uint32
    getLastSentMsgTimestamp()
    Return lastSentMsgTimestamp, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getReceivedMsgCount()
    Return receivedMsgCount, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getSentMsgCount()
    Return sentMsgCount, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getUnknownMsgReceived()
    Return unknownMsgReceived, or null if it is not present.
    default Class<Messages>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireLastSentMsgTimestamp()
    Return lastSentMsgTimestamp, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireReceivedMsgCount()
    Return receivedMsgCount, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireSentMsgCount()
    Return sentMsgCount, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireUnknownMsgReceived()
    Return unknownMsgReceived, guaranteed to be non-null.

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

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.ErrorMessagesGrouping

    getErrorMessages, nonnullErrorMessages

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.ReplyTimeGrouping

    getReplyTime, nonnullReplyTime

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<Messages> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface ErrorMessagesGrouping
      Specified by:
      implementedInterface in interface ReplyTimeGrouping

    • bindingHashCode

      static int bindingHashCode(@NonNull Messages 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 Messages 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 Messages 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

    • getReceivedMsgCount

      org.opendaylight.yangtools.yang.common.Uint32 getReceivedMsgCount()
      Return receivedMsgCount, or null if it is not present. 
           
         Total number of received PCEP messages.
      Returns:
      Uint32 receivedMsgCount, or null if it is not present.

    • requireReceivedMsgCount

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireReceivedMsgCount()
      Return receivedMsgCount, guaranteed to be non-null. 
           
         Total number of received PCEP messages.
      Returns:
      Uint32 receivedMsgCount, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if receivedMsgCount is not present

    • getSentMsgCount

      org.opendaylight.yangtools.yang.common.Uint32 getSentMsgCount()
      Return sentMsgCount, or null if it is not present. 
           
         Total number of sent PCEP messages.
      Returns:
      Uint32 sentMsgCount, or null if it is not present.

    • requireSentMsgCount

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireSentMsgCount()
      Return sentMsgCount, guaranteed to be non-null. 
           
         Total number of sent PCEP messages.
      Returns:
      Uint32 sentMsgCount, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if sentMsgCount is not present

    • getLastSentMsgTimestamp

      org.opendaylight.yangtools.yang.common.Uint32 getLastSentMsgTimestamp()
      Return lastSentMsgTimestamp, or null if it is not present. 
           
         The timestamp of last sent message.
      Returns:
      Uint32 lastSentMsgTimestamp, or null if it is not present.

    • requireLastSentMsgTimestamp

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireLastSentMsgTimestamp()
      Return lastSentMsgTimestamp, guaranteed to be non-null. 
           
         The timestamp of last sent message.
      Returns:
      Uint32 lastSentMsgTimestamp, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if lastSentMsgTimestamp is not present

    • getUnknownMsgReceived

      org.opendaylight.yangtools.yang.common.Uint16 getUnknownMsgReceived()
      Return unknownMsgReceived, or null if it is not present. 
           
         The number of received unknown messages.
      Returns:
      Uint16 unknownMsgReceived, or null if it is not present.

    • requireUnknownMsgReceived

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireUnknownMsgReceived()
      Return unknownMsgReceived, guaranteed to be non-null. 
           
         The number of received unknown messages.
      Returns:
      Uint16 unknownMsgReceived, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if unknownMsgReceived is not present