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;
   }
 }
 

The schema path to identify an instance is opendaylight-flow-types/flow

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME

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 Boolean	isBarrier()	Deprecated, for removal: This API element is subject to removal in a future version.
default Boolean	isInstallHw()	Deprecated, for removal: This API element is subject to removal in a future version.
default Boolean	isStrict()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes

getCookie, getHardTimeout, getIdleTimeout, getPriority, getTableId

Field Detail

QNAME

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

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:

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match match, or null if it is not present.

getInstructions

Instructions getInstructions()

Return instructions, or null if it is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Instructions instructions, or null if it is not present.

getContainerName

String getContainerName()

Return containerName, or null if it is not present.

Returns:

java.lang.String containerName, or null if it is not present.

getCookieMask

FlowCookie getCookieMask()

Return cookieMask, or null if it is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie cookieMask, or null if it is not present.

getBufferId

org.opendaylight.yangtools.yang.common.Uint32 getBufferId()

Return bufferId, or null if it is not present.

Returns:

org.opendaylight.yangtools.yang.common.Uint32 bufferId, or null if it is not present.

getOutPort

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

Return outPort, or null if it is not present.

Returns:

org.opendaylight.yangtools.yang.common.Uint64 outPort, or null if it is not present.

getOutGroup

org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()

Return outGroup, or null if it is not present.

Returns:

org.opendaylight.yangtools.yang.common.Uint32 outGroup, or null if it is not present.

getFlags

FlowModFlags getFlags()

Return flags, or null if it is not present.

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowModFlags flags, or null if it is not present.

getFlowName

String getFlowName()

Return flowName, or null if it is not present.

Returns:

java.lang.String flowName, or null if it is not present.

getInstallHw

Boolean getInstallHw()

Return installHw, or null if it is not present.

Returns:

java.lang.Boolean installHw, or null if it is not present.

isInstallHw

@Deprecated(forRemoval=true)
default Boolean isInstallHw()

Deprecated, for removal: This API element is subject to removal in a future version.

getBarrier

Boolean getBarrier()

Return barrier, or null if it is not present.

Returns:

java.lang.Boolean barrier, or null if it is not present.

isBarrier

@Deprecated(forRemoval=true)
default Boolean isBarrier()

Deprecated, for removal: This API element is subject to removal in a future version.

getStrict

Boolean getStrict()

Return strict, or null if it is not present.

Returns:

java.lang.Boolean strict, or null if it is not present.

isStrict

@Deprecated(forRemoval=true)
default Boolean isStrict()

Deprecated, for removal: This API element is subject to removal in a future version.