Interface FlowMod

  • All Superinterfaces:
    ActionsGrouping, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, InstructionsGrouping, MatchGrouping, MatchV10Grouping, OfHeader
    All Known Subinterfaces:
    FlowModCaseData, FlowModInput

    public interface FlowMod
    extends org.opendaylight.yangtools.yang.binding.DataObject, 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;
     }
     
    The schema path to identify an instance is openflow-protocol/flow-mod
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • getCookie

        @Nullable org.opendaylight.yangtools.yang.common.Uint64 getCookie()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 cookie, or null if not present
      • getCookieMask

        @Nullable org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 cookieMask, or null if not present
      • getTableId

        @Nullable TableId getTableId()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableId tableId, or null if not present
      • getCommand

        @Nullable FlowModCommand getCommand()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModCommand command, or null if not present
      • getIdleTimeout

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 idleTimeout, or null if not present
      • getHardTimeout

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 hardTimeout, or null if not present
      • getPriority

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getPriority()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 priority, or null if not present
      • getBufferId

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 bufferId, or null if not present
      • getOutPort

        @Nullable PortNumber getOutPort()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber outPort, or null if not present
      • getOutGroup

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 outGroup, or null if not present
      • getFlags

        @Nullable FlowModFlags getFlags()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlags flags, or null if not present
      • getFlagsV10

        @Nullable FlowModFlagsV10 getFlagsV10()
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlagsV10 flagsV10, or null if not present