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

Interface FlowMod$G

All Superinterfaces:
ActionsGrouping, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.Grouping, InstructionsGrouping, MatchGrouping, MatchV10Grouping, OfHeader
All Known Subinterfaces:
FlowModCaseData, FlowModInput
@Generated("mdsal-binding-generator") public interface FlowMod$G extends org.opendaylight.yangtools.binding.Grouping, OfHeader, MatchGrouping, InstructionsGrouping, MatchV10Grouping, ActionsGrouping

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

 grouping flow-mod {
   uses ofHeader;
   leaf cookie {
     type uint64;
   }
   leaf cookie-mask {
     type uint64;
   }
   leaf table-id {
     type oft:table-id;
   }
   leaf command {
     type oft:flow-mod-command;
   }
   leaf idle-timeout {
     type uint16;
   }
   leaf hard-timeout {
     type uint16;
   }
   leaf priority {
     type uint16;
   }
   leaf buffer-id {
     type uint32;
   }
   leaf out-port {
     type oft:port-number;
   }
   leaf out-group {
     type uint32;
   }
   leaf flags {
     type oft:flow-mod-flags;
   }
   uses oxm:match-grouping;
   uses ofinstruction:instructions-grouping;
   leaf flags-v10 {
     type oft:flow-mod-flags-v10;
   }
   uses oxm:match-v10-grouping;
   uses ofaction:actions-grouping;
 }

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint32
    getBufferId()
    Return bufferId, or null if it is not present.
    FlowModCommand
    getCommand()
    Return command, 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.Uint64
    getCookieMask()
    Return cookieMask, or null if it is not present.
    FlowModFlags
    getFlags()
    Return flags, or null if it is not present.
    FlowModFlagsV10
    getFlagsV10()
    Return flagsV10, 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.Uint32
    getOutGroup()
    Return outGroup, or null if it is not present.
    PortNumber
    getOutPort()
    Return outPort, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getPriority()
    Return priority, or null if it is not present.
    TableId
    getTableId()
    Return tableId, or null if it is not present.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireBufferId()
    Return bufferId, guaranteed to be non-null.
    default @NonNull FlowModCommand
    requireCommand()
    Return command, 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.Uint64
    requireCookieMask()
    Return cookieMask, guaranteed to be non-null.
    default @NonNull FlowModFlags
    requireFlags()
    Return flags, guaranteed to be non-null.
    default @NonNull FlowModFlagsV10
    requireFlagsV10()
    Return flagsV10, 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.Uint32
    requireOutGroup()
    Return outGroup, guaranteed to be non-null.
    default @NonNull PortNumber
    requireOutPort()
    Return outPort, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requirePriority()
    Return priority, 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.common.action.rev150203.ActionsGrouping

    getAction, nonnullAction

    Methods inherited from interface org.opendaylight.yangtools.binding.BindingContract

    implementedInterface

    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, nonnullMatch

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

    getMatchV10, nonnullMatchV10

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

    getVersion, getXid, requireVersion, requireXid

  • Method Details

    • 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

    • getCookieMask

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

    • requireCookieMask

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

    • getCommand

      FlowModCommand getCommand()
      Return command, or null if it is not present.
      Returns:
      FlowModCommand command, or null if it is not present.

    • requireCommand

      default @NonNull FlowModCommand requireCommand()
      Return command, guaranteed to be non-null.
      Returns:
      FlowModCommand command, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if command 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

    • 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

    • getBufferId

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

    • requireBufferId

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

    • getOutPort

      PortNumber getOutPort()
      Return outPort, or null if it is not present.
      Returns:
      PortNumber outPort, or null if it is not present.

    • requireOutPort

      default @NonNull PortNumber requireOutPort()
      Return outPort, guaranteed to be non-null.
      Returns:
      PortNumber outPort, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if outPort is not present

    • getOutGroup

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

    • requireOutGroup

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

    • getFlagsV10

      FlowModFlagsV10 getFlagsV10()
      Return flagsV10, or null if it is not present.
      Returns:
      FlowModFlagsV10 flagsV10, or null if it is not present.

    • requireFlagsV10

      default @NonNull FlowModFlagsV10 requireFlagsV10()
      Return flagsV10, guaranteed to be non-null.
      Returns:
      FlowModFlagsV10 flagsV10, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if flagsV10 is not present