NodeFlow (openflowplugin 0.14.4-SNAPSHOT API)

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, Flow, GenericFlowAttributes, NodeContextRef

All Known Subinterfaces:

AddFlowInput, FlowAdded, FlowRemoved, FlowUpdated, RemoveFlowInput
```
@Generated("mdsal-binding-generator")
public interface NodeFlow
extends org.opendaylight.yangtools.yang.binding.DataObject, NodeContextRef, Flow
```
Top openflow flow structure suitable for rpc input (contains node-context).
This class represents the following YANG schema fragment defined in module sal-flow
```
 grouping node-flow {
   uses inv:node-context-ref;
   leaf flow-table {
     type flow-table-ref;
   }
   uses types:flow;
 }
 
```

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
YANG identifier of the statement represented by this class.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`FlowTableRef`	`getFlowTable()`	Return flowTable, or `null` if it is not present.
`Class<? extends NodeFlow>`	`implementedInterface()`
`default @NonNull FlowTableRef`	`requireFlowTable()`	Return flowTable, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow
getBarrier, getBufferId, getContainerName, getCookieMask, getFlags, getFlowName, getInstallHw, getInstructions, getMatch, getOutGroup, getOutPort, getStrict, requireBarrier, requireBufferId, requireContainerName, requireCookieMask, requireFlags, requireFlowName, requireInstallHw, requireOutGroup, requireOutPort, requireStrict

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
getCookie, getHardTimeout, getIdleTimeout, getPriority, getTableId, requireCookie, requireHardTimeout, requireIdleTimeout, requirePriority, requireTableId

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
getNode, requireNode

- Field Detail
  - QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
    YANG identifier of the statement represented by this class.
- Method Detail
  - implementedInterface
```
Class<? extends NodeFlow> implementedInterface()
```
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
    
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
    
    Specified by:
    
    implementedInterface in interface Flow
    
    Specified by:
    
    implementedInterface in interface GenericFlowAttributes
    
    Specified by:
    
    implementedInterface in interface NodeContextRef
  - getFlowTable
```
FlowTableRef getFlowTable()
```
    Return flowTable, or null if it is not present.
    
    Returns:
    
    FlowTableRef flowTable, or null if it is not present.
  - requireFlowTable
```
default @NonNull FlowTableRef requireFlowTable()
```
    Return flowTable, guaranteed to be non-null.
    
    Returns:
    
    FlowTableRef flowTable, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if flowTable is not present