Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026

Interface Flow

All Superinterfaces:

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

All Known Subinterfaces:

AddFlowCaseData, AddFlowInput, BatchAddFlows, BatchFlowInputGrouping, BatchRemoveFlows, BulkFlowBaseContentGrouping, BulkFlowDsItem, BulkFlowItem, FlatBatchAddFlow, FlatBatchRemoveFlow, Flow, FlowAdded, FlowAggregateStats, FlowAndStatisticsMap, FlowAndStatisticsMapList, FlowMessage, FlowRemoved, FlowStats, FlowUpdated, GetAggregateFlowStatisticsFromFlowTableForGivenMatchInput, GetFlowStatisticsFromFlowTableInput, GetFlowStatisticsInput, NodeFlow, OriginalBatchedFlow, OriginalFlow, RemoveFlowCaseData, RemoveFlowInput, StaleFlow, UpdatedBatchedFlow, UpdatedFlow, UpdateFlowCaseData

@Generated("mdsal-binding-generator")
public interface Flow
extends org.opendaylight.yangtools.yang.binding.DataObject, GenericFlowAttributes

This class represents the following YANG schema fragment defined in module opendaylight-flow-types

 grouping flow {
   container match {
     uses match:match;
   }
   container instructions {
     uses instruction-list;
   }
   uses generic_flow_attributes;
   leaf container-name {
     type string;
   }
   leaf cookie_mask {
     type flow-cookie;
   }
   leaf buffer_id {
     type uint32;
   }
   leaf out_port {
     type uint64;
   }
   leaf out_group {
     type uint32;
   }
   leaf flags {
     type flow-mod-flags;
   }
   leaf flow-name {
     type string;
   }
   leaf installHw {
     type boolean;
   }
   leaf barrier {
     type boolean;
   }
   leaf strict {
     type boolean;
     default false;
   }
 }
 

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

Modifier and Type	Method	Description
Boolean	getBarrier()	Return barrier, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getBufferId()	Return bufferId, or null if it is not present.
String	getContainerName()	Return containerName, or null if it is not present.
FlowCookie	getCookieMask()	Return cookieMask, or null if it is not present.
FlowModFlags	getFlags()	Return flags, or null if it is not present.
String	getFlowName()	Return flowName, or null if it is not present.
Boolean	getInstallHw()	Return installHw, or null if it is not present.
Instructions	getInstructions()	Return instructions, or null if it is not present.
Match	getMatch()	Return match, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint32	getOutGroup()	Return outGroup, or null if it is not present.
org.opendaylight.yangtools.yang.common.Uint64	getOutPort()	Return outPort, or null if it is not present.
Boolean	getStrict()	Return strict, or null if it is not present.
Class<? extends Flow>	implementedInterface()
default @NonNull Boolean	requireBarrier()	Return barrier, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireBufferId()	Return bufferId, guaranteed to be non-null.
default @NonNull String	requireContainerName()	Return containerName, guaranteed to be non-null.
default @NonNull FlowCookie	requireCookieMask()	Return cookieMask, guaranteed to be non-null.
default @NonNull FlowModFlags	requireFlags()	Return flags, guaranteed to be non-null.
default @NonNull String	requireFlowName()	Return flowName, guaranteed to be non-null.
default @NonNull Boolean	requireInstallHw()	Return installHw, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint32	requireOutGroup()	Return outGroup, guaranteed to be non-null.
default @NonNull org.opendaylight.yangtools.yang.common.Uint64	requireOutPort()	Return outPort, guaranteed to be non-null.
default @NonNull Boolean	requireStrict()	Return strict, guaranteed to be non-null.

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

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 Flow> 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 GenericFlowAttributes

getMatch

Match getMatch()

Return match, or null if it is not present.

Returns:

Match match, or null if it is not present.

getInstructions

Instructions getInstructions()

Return instructions, or null if it is not present.

Returns:

Instructions instructions, or null if it is not present.

getContainerName

String getContainerName()

Return containerName, or null if it is not present.

Returns:

String containerName, or null if it is not present.

requireContainerName

default @NonNull String requireContainerName()

Return containerName, guaranteed to be non-null.

Returns:

String containerName, guaranteed to be non-null.

Throws:

NoSuchElementException - if containerName is not present

getCookieMask

FlowCookie getCookieMask()

Return cookieMask, or null if it is not present.

Returns:

FlowCookie cookieMask, or null if it is not present.

requireCookieMask

default @NonNull FlowCookie requireCookieMask()

Return cookieMask, guaranteed to be non-null.

Returns:

FlowCookie cookieMask, guaranteed to be non-null.

Throws:

NoSuchElementException - if cookieMask 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

org.opendaylight.yangtools.yang.common.Uint64 getOutPort()

Return outPort, or null if it is not present.

Returns:

Uint64 outPort, or null if it is not present.

requireOutPort

default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireOutPort()

Return outPort, guaranteed to be non-null.

Returns:

Uint64 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

getFlowName

String getFlowName()

Return flowName, or null if it is not present.

Returns:

String flowName, or null if it is not present.

requireFlowName

default @NonNull String requireFlowName()

Return flowName, guaranteed to be non-null.

Returns:

String flowName, guaranteed to be non-null.

Throws:

NoSuchElementException - if flowName is not present

getInstallHw

Boolean getInstallHw()

Return installHw, or null if it is not present.

Returns:

Boolean installHw, or null if it is not present.

requireInstallHw

default @NonNull Boolean requireInstallHw()

Return installHw, guaranteed to be non-null.

Returns:

Boolean installHw, guaranteed to be non-null.

Throws:

NoSuchElementException - if installHw is not present

getBarrier

Boolean getBarrier()

Return barrier, or null if it is not present.

Returns:

Boolean barrier, or null if it is not present.

requireBarrier

default @NonNull Boolean requireBarrier()

Return barrier, guaranteed to be non-null.

Returns:

Boolean barrier, guaranteed to be non-null.

Throws:

NoSuchElementException - if barrier is not present

getStrict

Boolean getStrict()

Return strict, or null if it is not present.

Returns:

Boolean strict, or null if it is not present.

requireStrict

default @NonNull Boolean requireStrict()

Return strict, guaranteed to be non-null.

Returns:

Boolean strict, guaranteed to be non-null.

Throws:

NoSuchElementException - if strict is not present