Instructions (onos-api 1.2.0 API)

java.lang.Object
- org.onosproject.net.flow.instructions.Instructions

```
public final class Instructions
extends Object
```
Factory class for creating various traffic treatment instructions.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Instructions.DropInstruction` Drop instruction.
`static class`	`Instructions.GroupInstruction` Group Instruction.
`static class`	`Instructions.MetadataInstruction` Metadata instruction.
`static class`	`Instructions.OutputInstruction` Output Instruction.
`static class`	`Instructions.TableTypeTransition` Transition instruction.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static L3ModificationInstruction`	`copyTtlIn()` Creates a L3 copy TTL to inner header modification.
`static L3ModificationInstruction`	`copyTtlOut()` Creates a L3 copy TTL to outer header modification.
`static Instructions.DropInstruction`	`createDrop()` Creates a drop instruction.
`static Instructions.GroupInstruction`	`createGroup(GroupId groupId)` Creates a group instruction.
`static Instructions.OutputInstruction`	`createOutput(PortNumber number)` Creates an output instruction using the specified port number.
`static L2ModificationInstruction`	`decMplsTtl()` Creates a MPLS decrement TTL modification.
`static L3ModificationInstruction`	`decNwTtl()` Creates a L3 decrement TTL modification.
`static L0ModificationInstruction`	`modL0Lambda(Lambda lambda)` Creates an L0 modification with the specified OCh signal.
`static L0ModificationInstruction`	`modL0Lambda(short lambda)` Deprecated. in Cardinal Release. Use `modL0Lambda(Lambda)` instead.
`static L2ModificationInstruction`	`modL2Dst(org.onlab.packet.MacAddress addr)` Creates a L2 dst modification.
`static L2ModificationInstruction`	`modL2Src(org.onlab.packet.MacAddress addr)` Creates a l2 src modification.
`static L3ModificationInstruction`	`modL3Dst(org.onlab.packet.IpAddress addr)` Creates a L3 IPv4 dst modification.
`static L3ModificationInstruction`	`modL3IPv6Dst(org.onlab.packet.IpAddress addr)` Creates a L3 IPv6 dst modification.
`static L3ModificationInstruction`	`modL3IPv6FlowLabel(int flowLabel)` Creates a L3 IPv6 Flow Label modification.
`static L3ModificationInstruction`	`modL3IPv6Src(org.onlab.packet.IpAddress addr)` Creates a L3 IPv6 src modification.
`static L3ModificationInstruction`	`modL3Src(org.onlab.packet.IpAddress addr)` Creates a L3 IPv4 src modification.
`static L2ModificationInstruction`	`modMplsLabel(org.onlab.packet.MplsLabel mplsLabel)` Creates a MPLS label modification.
`static L2ModificationInstruction`	`modVlanId(org.onlab.packet.VlanId vlanId)` Creates a VLAN ID modification.
`static L2ModificationInstruction`	`modVlanPcp(Byte vlanPcp)` Creates a VLAN PCP modification.
`static Instruction`	`popMpls()` Creates a pop MPLS header instruction.
`static Instruction`	`popMpls(int etherType)` Creates a pop MPLS header instruction with a particular ethertype.
`static Instruction`	`popVlan()` Creates a pop VLAN header instruction.
`static Instruction`	`pushMpls()` Creates a push MPLS header instruction.
`static Instruction`	`pushVlan()` Creates a push VLAN header instruction.
`static Instruction`	`transition(Integer tableId)` Sends the packet to the table id.
`static Instruction`	`writeMetadata(long metadata, long metadataMask)` Writes metadata to associate with a packet.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createOutput
```
public static Instructions.OutputInstruction createOutput(PortNumber number)
```
    Creates an output instruction using the specified port number. This can include logical ports such as CONTROLLER, FLOOD, etc.
    
    Parameters:
    
    number - port number
    
    Returns:
    
    output instruction
  - createDrop
```
public static Instructions.DropInstruction createDrop()
```
    Creates a drop instruction.
    
    Returns:
    
    drop instruction
  - createGroup
```
public static Instructions.GroupInstruction createGroup(GroupId groupId)
```
    Creates a group instruction.
    
    Parameters:
    
    groupId - Group Id
    
    Returns:
    
    group instruction
  - modL0Lambda
```
@Deprecated
public static L0ModificationInstruction modL0Lambda(short lambda)
```
    Deprecated. in Cardinal Release. Use modL0Lambda(Lambda) instead.
    
    Creates a l0 modification.
    
    Parameters:
    
    lambda - the lambda to modify to
    
    Returns:
    
    a l0 modification
  - modL0Lambda
```
public static L0ModificationInstruction modL0Lambda(Lambda lambda)
```
    Creates an L0 modification with the specified OCh signal.
    
    Parameters:
    
    lambda - OCh signal
    
    Returns:
    
    an L0 modification
  - modL2Src
```
public static L2ModificationInstruction modL2Src(org.onlab.packet.MacAddress addr)
```
    Creates a l2 src modification.
    
    Parameters:
    
    addr - the mac address to modify to
    
    Returns:
    
    a l2 modification
  - modL2Dst
```
public static L2ModificationInstruction modL2Dst(org.onlab.packet.MacAddress addr)
```
    Creates a L2 dst modification.
    
    Parameters:
    
    addr - the mac address to modify to
    
    Returns:
    
    a L2 modification
  - modVlanId
```
public static L2ModificationInstruction modVlanId(org.onlab.packet.VlanId vlanId)
```
    Creates a VLAN ID modification.
    
    Parameters:
    
    vlanId - the VLAN ID to modify to
    
    Returns:
    
    a L2 modification
  - modVlanPcp
```
public static L2ModificationInstruction modVlanPcp(Byte vlanPcp)
```
    Creates a VLAN PCP modification.
    
    Parameters:
    
    vlanPcp - the PCP to modify to
    
    Returns:
    
    a L2 modification
  - modMplsLabel
```
public static L2ModificationInstruction modMplsLabel(org.onlab.packet.MplsLabel mplsLabel)
```
    Creates a MPLS label modification.
    
    Parameters:
    
    mplsLabel - MPLS label to set
    
    Returns:
    
    a L2 Modification
  - decMplsTtl
```
public static L2ModificationInstruction decMplsTtl()
```
    Creates a MPLS decrement TTL modification.
    
    Returns:
    
    a L2 Modification
  - modL3Src
```
public static L3ModificationInstruction modL3Src(org.onlab.packet.IpAddress addr)
```
    Creates a L3 IPv4 src modification.
    
    Parameters:
    
    addr - the IPv4 address to modify to
    
    Returns:
    
    a L3 modification
  - modL3Dst
```
public static L3ModificationInstruction modL3Dst(org.onlab.packet.IpAddress addr)
```
    Creates a L3 IPv4 dst modification.
    
    Parameters:
    
    addr - the IPv4 address to modify to
    
    Returns:
    
    a L3 modification
  - modL3IPv6Src
```
public static L3ModificationInstruction modL3IPv6Src(org.onlab.packet.IpAddress addr)
```
    Creates a L3 IPv6 src modification.
    
    Parameters:
    
    addr - the IPv6 address to modify to
    
    Returns:
    
    a L3 modification
  - modL3IPv6Dst
```
public static L3ModificationInstruction modL3IPv6Dst(org.onlab.packet.IpAddress addr)
```
    Creates a L3 IPv6 dst modification.
    
    Parameters:
    
    addr - the IPv6 address to modify to
    
    Returns:
    
    a L3 modification
  - modL3IPv6FlowLabel
```
public static L3ModificationInstruction modL3IPv6FlowLabel(int flowLabel)
```
    Creates a L3 IPv6 Flow Label modification.
    
    Parameters:
    
    flowLabel - the IPv6 flow label to modify to (20 bits)
    
    Returns:
    
    a L3 modification
  - decNwTtl
```
public static L3ModificationInstruction decNwTtl()
```
    Creates a L3 decrement TTL modification.
    
    Returns:
    
    a L3 modification
  - copyTtlOut
```
public static L3ModificationInstruction copyTtlOut()
```
    Creates a L3 copy TTL to outer header modification.
    
    Returns:
    
    a L3 modification
  - copyTtlIn
```
public static L3ModificationInstruction copyTtlIn()
```
    Creates a L3 copy TTL to inner header modification.
    
    Returns:
    
    a L3 modification
  - pushMpls
```
public static Instruction pushMpls()
```
    Creates a push MPLS header instruction.
    
    Returns:
    
    a L2 modification.
  - popMpls
```
public static Instruction popMpls()
```
    Creates a pop MPLS header instruction.
    
    Returns:
    
    a L2 modification.
  - popMpls
```
public static Instruction popMpls(int etherType)
```
    Creates a pop MPLS header instruction with a particular ethertype.
    
    Parameters:
    
    etherType - Ethernet type to set
    
    Returns:
    
    a L2 modification.
  - popVlan
```
public static Instruction popVlan()
```
    Creates a pop VLAN header instruction.
    
    Returns:
    
    a L2 modification
  - pushVlan
```
public static Instruction pushVlan()
```
    Creates a push VLAN header instruction.
    
    Returns:
    
    a L2 modification
  - transition
```
public static Instruction transition(Integer tableId)
```
    Sends the packet to the table id.
    
    Parameters:
    
    tableId - flow rule table id
    
    Returns:
    
    table type transition instruction
  - writeMetadata
```
public static Instruction writeMetadata(long metadata,
                                        long metadataMask)
```
    Writes metadata to associate with a packet.
    
    Parameters:
    
    metadata - the metadata value to write
    
    metadataMask - the bits to mask for the metadata value
    
    Returns:
    
    metadata instruction

Class Instructions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createOutput

createDrop

createGroup

modL0Lambda

modL0Lambda

modL2Src

modL2Dst

modVlanId

modVlanPcp

modMplsLabel

decMplsTtl

modL3Src

modL3Dst

modL3IPv6Src

modL3IPv6Dst

modL3IPv6FlowLabel

decNwTtl

copyTtlOut

copyTtlIn

pushMpls

popMpls

popMpls

popVlan

pushVlan

transition

writeMetadata