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

Interface FlowStats

All Superinterfaces:
ActionsGrouping, org.opendaylight.yangtools.yang.binding.Augmentable<FlowStats>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MultipartReplyFlow>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, InstructionsGrouping, MatchGrouping, MatchV10Grouping
@Generated("mdsal-binding-generator") public interface FlowStats extends org.opendaylight.yangtools.yang.binding.ChildOf<MultipartReplyFlow>, org.opendaylight.yangtools.yang.binding.Augmentable<FlowStats>, MatchGrouping, InstructionsGrouping, MatchV10Grouping, ActionsGrouping

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

 list flow-stats {
   leaf table-id {
     type uint8;
   }
   leaf duration-sec {
     type uint32;
   }
   leaf duration-nsec {
     type uint32;
   }
   leaf priority {
     type uint16;
   }
   leaf idle-timeout {
     type uint16;
   }
   leaf hard-timeout {
     type uint16;
   }
   leaf flags {
     type oft:flow-mod-flags;
   }
   leaf cookie {
     type uint64;
   }
   leaf packet-count {
     type uint64;
   }
   leaf byte-count {
     type uint64;
   }
   uses oxm:match-grouping;
   uses ofinstruction:instructions-grouping;
   uses oxm:match-v10-grouping;
   uses ofaction:actions-grouping;
 }

To create instances of this class use FlowStatsBuilder.

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 FlowStats thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull FlowStats obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull FlowStats obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yangtools.yang.common.Uint64
    getByteCount()
    Return byteCount, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getCookie()
    Return cookie, 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.
    FlowModFlags
    getFlags()
    Return flags, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getHardTimeout()
    Return hardTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getIdleTimeout()
    Return idleTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint64
    getPacketCount()
    Return packetCount, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getPriority()
    Return priority, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getTableId()
    Return tableId, or null if it is not present.
    default Class<FlowStats>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireByteCount()
    Return byteCount, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireCookie()
    Return cookie, 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 FlowModFlags
    requireFlags()
    Return flags, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireHardTimeout()
    Return hardTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireIdleTimeout()
    Return idleTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requirePacketCount()
    Return packetCount, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requirePriority()
    Return priority, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireTableId()
    Return tableId, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping

    getAction, nonnullAction

    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.openflow.common.instruction.rev130731.InstructionsGrouping

    getInstruction, nonnullInstruction

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping

    getMatch

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchV10Grouping

    getMatchV10

  • 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<FlowStats> implementedInterface()
      Specified by:
      implementedInterface in interface ActionsGrouping
      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 InstructionsGrouping
      Specified by:
      implementedInterface in interface MatchGrouping
      Specified by:
      implementedInterface in interface MatchV10Grouping

    • bindingHashCode

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

    • getTableId

      org.opendaylight.yangtools.yang.common.Uint8 getTableId()
      Return tableId, or null if it is not present.
      Returns:
      Uint8 tableId, or null if it is not present.

    • requireTableId

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireTableId()
      Return tableId, guaranteed to be non-null.
      Returns:
      Uint8 tableId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if tableId 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

    • getPriority

      org.opendaylight.yangtools.yang.common.Uint16 getPriority()
      Return priority, or null if it is not present.
      Returns:
      Uint16 priority, or null if it is not present.

    • requirePriority

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

    • getIdleTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
      Return idleTimeout, or null if it is not present.
      Returns:
      Uint16 idleTimeout, or null if it is not present.

    • requireIdleTimeout

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

    • getHardTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
      Return hardTimeout, or null if it is not present.
      Returns:
      Uint16 hardTimeout, or null if it is not present.

    • requireHardTimeout

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

    • getFlags

      FlowModFlags getFlags()
      Return flags, or null if it is not present.
      Returns:
      FlowModFlags flags, or null if it is not present.

    • requireFlags

      default @NonNull FlowModFlags requireFlags()
      Return flags, guaranteed to be non-null.
      Returns:
      FlowModFlags flags, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if flags is not present

    • getCookie

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

    • requireCookie

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

    • getPacketCount

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

    • requirePacketCount

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

    • getByteCount

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

    • requireByteCount

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