Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats

Interface PortStats

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<PortStats>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MultipartReplyPortStats>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface PortStats extends org.opendaylight.yangtools.yang.binding.ChildOf<MultipartReplyPortStats>, org.opendaylight.yangtools.yang.binding.Augmentable<PortStats>

This class represents the following YANG schema fragment defined in module openflow-protocol 

 list port-stats {
   leaf port-no {
     type uint32;
   }
   leaf rx-packets {
     type uint64;
   }
   leaf tx-packets {
     type uint64;
   }
   leaf rx-bytes {
     type uint64;
   }
   leaf tx-bytes {
     type uint64;
   }
   leaf rx-dropped {
     type uint64;
   }
   leaf tx-dropped {
     type uint64;
   }
   leaf rx-errors {
     type uint64;
   }
   leaf tx-errors {
     type uint64;
   }
   leaf rx-frame-err {
     type uint64;
   }
   leaf rx-over-err {
     type uint64;
   }
   leaf rx-crc-err {
     type uint64;
   }
   leaf collisions {
     type uint64;
   }
   leaf duration-sec {
     type uint32;
   }
   leaf duration-nsec {
     type uint32;
   }
 }

To create instances of this class use PortStatsBuilder.

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 PortStats thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull PortStats obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull PortStats obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yangtools.yang.common.Uint64
    getCollisions()
    Return collisions, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getDurationNsec()
    Return durationNsec, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getDurationSec()
    Return durationSec, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getPortNo()
    Return portNo, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxBytes()
    Return rxBytes, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxCrcErr()
    Return rxCrcErr, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxDropped()
    Return rxDropped, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxErrors()
    Return rxErrors, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxFrameErr()
    Return rxFrameErr, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxOverErr()
    Return rxOverErr, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getRxPackets()
    Return rxPackets, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getTxBytes()
    Return txBytes, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getTxDropped()
    Return txDropped, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getTxErrors()
    Return txErrors, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getTxPackets()
    Return txPackets, or null if it is not present.
    default Class<PortStats>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireCollisions()
    Return collisions, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireDurationNsec()
    Return durationNsec, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireDurationSec()
    Return durationSec, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requirePortNo()
    Return portNo, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxBytes()
    Return rxBytes, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxCrcErr()
    Return rxCrcErr, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxDropped()
    Return rxDropped, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxErrors()
    Return rxErrors, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxFrameErr()
    Return rxFrameErr, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxOverErr()
    Return rxOverErr, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireRxPackets()
    Return rxPackets, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireTxBytes()
    Return txBytes, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireTxDropped()
    Return txDropped, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireTxErrors()
    Return txErrors, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireTxPackets()
    Return txPackets, guaranteed to be non-null.

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

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

  • 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<PortStats> 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

    • bindingHashCode

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

    • getPortNo

      org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
      Return portNo, or null if it is not present.
      Returns:
      Uint32 portNo, or null if it is not present.

    • requirePortNo

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePortNo()
      Return portNo, guaranteed to be non-null.
      Returns:
      Uint32 portNo, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if portNo is not present

    • getRxPackets

      org.opendaylight.yangtools.yang.common.Uint64 getRxPackets()
      Return rxPackets, or null if it is not present.
      Returns:
      Uint64 rxPackets, or null if it is not present.

    • requireRxPackets

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxPackets()
      Return rxPackets, guaranteed to be non-null.
      Returns:
      Uint64 rxPackets, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxPackets is not present

    • getTxPackets

      org.opendaylight.yangtools.yang.common.Uint64 getTxPackets()
      Return txPackets, or null if it is not present.
      Returns:
      Uint64 txPackets, or null if it is not present.

    • requireTxPackets

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTxPackets()
      Return txPackets, guaranteed to be non-null.
      Returns:
      Uint64 txPackets, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if txPackets is not present

    • getRxBytes

      org.opendaylight.yangtools.yang.common.Uint64 getRxBytes()
      Return rxBytes, or null if it is not present.
      Returns:
      Uint64 rxBytes, or null if it is not present.

    • requireRxBytes

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxBytes()
      Return rxBytes, guaranteed to be non-null.
      Returns:
      Uint64 rxBytes, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxBytes is not present

    • getTxBytes

      org.opendaylight.yangtools.yang.common.Uint64 getTxBytes()
      Return txBytes, or null if it is not present.
      Returns:
      Uint64 txBytes, or null if it is not present.

    • requireTxBytes

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTxBytes()
      Return txBytes, guaranteed to be non-null.
      Returns:
      Uint64 txBytes, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if txBytes is not present

    • getRxDropped

      org.opendaylight.yangtools.yang.common.Uint64 getRxDropped()
      Return rxDropped, or null if it is not present.
      Returns:
      Uint64 rxDropped, or null if it is not present.

    • requireRxDropped

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxDropped()
      Return rxDropped, guaranteed to be non-null.
      Returns:
      Uint64 rxDropped, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxDropped is not present

    • getTxDropped

      org.opendaylight.yangtools.yang.common.Uint64 getTxDropped()
      Return txDropped, or null if it is not present.
      Returns:
      Uint64 txDropped, or null if it is not present.

    • requireTxDropped

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTxDropped()
      Return txDropped, guaranteed to be non-null.
      Returns:
      Uint64 txDropped, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if txDropped is not present

    • getRxErrors

      org.opendaylight.yangtools.yang.common.Uint64 getRxErrors()
      Return rxErrors, or null if it is not present.
      Returns:
      Uint64 rxErrors, or null if it is not present.

    • requireRxErrors

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxErrors()
      Return rxErrors, guaranteed to be non-null.
      Returns:
      Uint64 rxErrors, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxErrors is not present

    • getTxErrors

      org.opendaylight.yangtools.yang.common.Uint64 getTxErrors()
      Return txErrors, or null if it is not present.
      Returns:
      Uint64 txErrors, or null if it is not present.

    • requireTxErrors

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTxErrors()
      Return txErrors, guaranteed to be non-null.
      Returns:
      Uint64 txErrors, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if txErrors is not present

    • getRxFrameErr

      org.opendaylight.yangtools.yang.common.Uint64 getRxFrameErr()
      Return rxFrameErr, or null if it is not present.
      Returns:
      Uint64 rxFrameErr, or null if it is not present.

    • requireRxFrameErr

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxFrameErr()
      Return rxFrameErr, guaranteed to be non-null.
      Returns:
      Uint64 rxFrameErr, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxFrameErr is not present

    • getRxOverErr

      org.opendaylight.yangtools.yang.common.Uint64 getRxOverErr()
      Return rxOverErr, or null if it is not present.
      Returns:
      Uint64 rxOverErr, or null if it is not present.

    • requireRxOverErr

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxOverErr()
      Return rxOverErr, guaranteed to be non-null.
      Returns:
      Uint64 rxOverErr, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxOverErr is not present

    • getRxCrcErr

      org.opendaylight.yangtools.yang.common.Uint64 getRxCrcErr()
      Return rxCrcErr, or null if it is not present.
      Returns:
      Uint64 rxCrcErr, or null if it is not present.

    • requireRxCrcErr

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireRxCrcErr()
      Return rxCrcErr, guaranteed to be non-null.
      Returns:
      Uint64 rxCrcErr, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if rxCrcErr is not present

    • getCollisions

      org.opendaylight.yangtools.yang.common.Uint64 getCollisions()
      Return collisions, or null if it is not present.
      Returns:
      Uint64 collisions, or null if it is not present.

    • requireCollisions

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireCollisions()
      Return collisions, guaranteed to be non-null.
      Returns:
      Uint64 collisions, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if collisions is not present

    • getDurationSec

      org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
      Return durationSec, or null if it is not present.
      Returns:
      Uint32 durationSec, or null if it is not present.

    • requireDurationSec

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDurationSec()
      Return durationSec, guaranteed to be non-null.
      Returns:
      Uint32 durationSec, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if durationSec is not present

    • getDurationNsec

      org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
      Return durationNsec, or null if it is not present.
      Returns:
      Uint32 durationNsec, or null if it is not present.

    • requireDurationNsec

      default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireDurationNsec()
      Return durationNsec, guaranteed to be non-null.
      Returns:
      Uint32 durationNsec, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if durationNsec is not present