Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Interface FlowRemoved

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, MatchGrouping, MatchV10Grouping, OfHeader
All Known Subinterfaces:
FlowRemovedMessage
@Generated("mdsal-binding-generator") public interface FlowRemoved extends org.opendaylight.yangtools.yang.binding.DataObject, OfHeader, MatchGrouping, MatchV10Grouping

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

 grouping flow-removed {
   uses ofHeader;
   leaf cookie {
     type uint64;
   }
   leaf priority {
     type uint16;
   }
   leaf reason {
     type oft:flow-removed-reason;
   }
   leaf table-id {
     type oft:table-id;
   }
   leaf duration-sec {
     type uint32;
   }
   leaf duration-nsec {
     type uint32;
   }
   leaf idle-timeout {
     type uint16;
   }
   leaf hard-timeout {
     type uint16;
   }
   leaf packet-count {
     type uint64;
   }
   leaf byte-count {
     type uint64;
   }
   uses oxm:match-grouping;
   uses oxm:match-v10-grouping;
 }

  • 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
    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.
    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.
    FlowRemovedReason
    getReason()
    Return reason, or null if it is not present.
    TableId
    getTableId()
    Return tableId, or null if it is not present.
    Class<? extends FlowRemoved>
    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 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 FlowRemovedReason
    requireReason()
    Return reason, guaranteed to be non-null.
    default @NonNull TableId
    requireTableId()
    Return tableId, guaranteed to be non-null.

    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

    Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader

    getVersion, getXid, requireVersion, requireXid

  • 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

      Class<? extends FlowRemoved> 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 MatchGrouping
      Specified by:
      implementedInterface in interface MatchV10Grouping
      Specified by:
      implementedInterface in interface OfHeader

    • 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

    • 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

    • getReason

      FlowRemovedReason getReason()
      Return reason, or null if it is not present.
      Returns:
      FlowRemovedReason reason, or null if it is not present.

    • requireReason

      default @NonNull FlowRemovedReason requireReason()
      Return reason, guaranteed to be non-null.
      Returns:
      FlowRemovedReason reason, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if reason is not present

    • getTableId

      TableId getTableId()
      Return tableId, or null if it is not present.
      Returns:
      TableId tableId, or null if it is not present.

    • requireTableId

      default @NonNull TableId requireTableId()
      Return tableId, guaranteed to be non-null.
      Returns:
      TableId 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

    • 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

    • 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