Open Kilda Java Documentation
org.openkilda.messaging.model.rule.FlowInstall Class Reference
Inheritance diagram for org.openkilda.messaging.model.rule.FlowInstall:
org.openkilda.messaging.model.rule.FlowDelete org.openkilda.messaging.model.rule.Rule org.openkilda.messaging.BaseMessage

Public Member Functions

 FlowInstall ()
 
 FlowInstall (@JsonProperty(RuleConstants.FLOW_ID) String flowId, @JsonProperty(RuleConstants.COOKIE) int cookie, @JsonProperty(RuleConstants.SWITCH_ID) String switchId, @JsonProperty(RuleConstants.MATCH_PORT) int matchPort, @JsonProperty(RuleConstants.MATCH_VLAN) int matchVlan, @JsonProperty(RuleConstants.OUTPUT_PORT) int outputPort, @JsonProperty(RuleConstants.OUTPUT_VLAN) int outputVlan, @JsonProperty(RuleConstants.OUTPUT_VLAN_TYPE) OutputVlanType outputVlanType, @JsonProperty(RuleConstants.METER_ID) int meterId, @JsonProperty(RuleConstants.PRIORITY) int priority)
 
int getOutputPort ()
 
void setOutputPort (int outputPort)
 
int getOutputVlan ()
 
void setOutputVlan (int outputVlan)
 
OutputVlanType getOutputVlanType ()
 
void setOutputVlanType (OutputVlanType outputVlanType)
 
int getMeterId ()
 
void setMeterId (int meterId)
 
int getPriority ()
 
void setPriority (int priority)
 
boolean equals (Object object)
 
int hashCode ()
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.model.rule.FlowDelete
 FlowDelete ()
 
 FlowDelete (@JsonProperty(RuleConstants.FLOW_ID) String flowId, @JsonProperty(RuleConstants.COOKIE) int cookie, @JsonProperty(RuleConstants.SWITCH_ID) String switchId, @JsonProperty(RuleConstants.MATCH_PORT) int matchPort, @JsonProperty(RuleConstants.MATCH_VLAN) int matchVlan)
 
int getMatchPort ()
 
void setMatchPort (int matchPort)
 
int getMatchVlan ()
 
void setMatchVlan (int matchVlan)
 
boolean equals (Object object)
 
int hashCode ()
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.model.rule.Rule
 Rule ()
 
 Rule (@JsonProperty(RuleConstants.FLOW_ID) String flowId, @JsonProperty(RuleConstants.COOKIE) int cookie, @JsonProperty(RuleConstants.SWITCH_ID) String switchId)
 
String getFlowId ()
 
void setFlowId (String flowId)
 
String getSwitchId ()
 
void setSwitchId (String switchId)
 
int getCookie ()
 
void setCookie (int cookie)
 
boolean equals (Object object)
 
int hashCode ()
 
String toString ()
 
- Public Member Functions inherited from org.openkilda.messaging.BaseMessage
 BaseMessage (@JsonProperty(TIMESTAMP) final long timestamp)
 
 BaseMessage ()
 
long getTimestamp ()
 
void setTimestamp (long timestamp)
 

Additional Inherited Members

- Static Public Member Functions inherited from org.openkilda.messaging.BaseMessage
static final< T extends BaseMessage > T getMessage (String json, Class< T > type) throws java.io.IOException
 
static final< T extends BaseMessage > T tryGetMessage (String json, Class< T > type)
 
- Protected Attributes inherited from org.openkilda.messaging.model.rule.FlowDelete
int matchPort
 
int matchVlan
 
- Protected Attributes inherited from org.openkilda.messaging.model.rule.Rule
String flowId
 
int cookie
 
String switchId
 
- Protected Attributes inherited from org.openkilda.messaging.BaseMessage
long timestamp = 0L
 

Detailed Description

Represents rule entity for FLOW_MOD/INSTALL OpenFlow command.

Definition at line 31 of file FlowInstall.java.

Constructor & Destructor Documentation

◆ FlowInstall() [1/2]

org.openkilda.messaging.model.rule.FlowInstall.FlowInstall ( )

Default constructor.

Definition at line 70 of file FlowInstall.java.

◆ FlowInstall() [2/2]

org.openkilda.messaging.model.rule.FlowInstall.FlowInstall ( @JsonProperty(RuleConstants.FLOW_ID) String  flowId,
@JsonProperty(RuleConstants.COOKIE) int  cookie,
@JsonProperty(RuleConstants.SWITCH_ID) String  switchId,
@JsonProperty(RuleConstants.MATCH_PORT) int  matchPort,
@JsonProperty(RuleConstants.MATCH_VLAN) int  matchVlan,
@JsonProperty(RuleConstants.OUTPUT_PORT) int  outputPort,
@JsonProperty(RuleConstants.OUTPUT_VLAN) int  outputVlan,
@JsonProperty(RuleConstants.OUTPUT_VLAN_TYPE) OutputVlanType  outputVlanType,
@JsonProperty(RuleConstants.METER_ID) int  meterId,
@JsonProperty(RuleConstants.PRIORITY) int  priority 
)

Instance constructor.

Parameters
flowIdrule flow id
cookierule cookie
switchIdrule switch id
matchPortrule match port
matchVlanrule match vlan id
outputPortrule output port
outputVlanrule output vlan id
outputVlanTyperule output vlan operation
meterIdrule meter id
priorityrule priority

Definition at line 87 of file FlowInstall.java.

Member Function Documentation

◆ equals()

boolean org.openkilda.messaging.model.rule.FlowInstall.equals ( Object  object)

Definition at line 199 of file FlowInstall.java.

◆ getMeterId()

int org.openkilda.messaging.model.rule.FlowInstall.getMeterId ( )

Gets meter id.

Returns
meter id

Definition at line 164 of file FlowInstall.java.

◆ getOutputPort()

int org.openkilda.messaging.model.rule.FlowInstall.getOutputPort ( )

Gets output port.

Returns
output port

Definition at line 110 of file FlowInstall.java.

◆ getOutputVlan()

int org.openkilda.messaging.model.rule.FlowInstall.getOutputVlan ( )

Gets output vlan.

Returns
output vlan

Definition at line 128 of file FlowInstall.java.

◆ getOutputVlanType()

OutputVlanType org.openkilda.messaging.model.rule.FlowInstall.getOutputVlanType ( )

Gets output vlan type.

Returns
output vlan type

Definition at line 146 of file FlowInstall.java.

◆ getPriority()

int org.openkilda.messaging.model.rule.FlowInstall.getPriority ( )

Gets priority.

Returns
priority

Definition at line 182 of file FlowInstall.java.

◆ hashCode()

int org.openkilda.messaging.model.rule.FlowInstall.hashCode ( )

Definition at line 225 of file FlowInstall.java.

◆ setMeterId()

void org.openkilda.messaging.model.rule.FlowInstall.setMeterId ( int  meterId)

Sets meter id.

Parameters
meterIdmeter id

Definition at line 173 of file FlowInstall.java.

◆ setOutputPort()

void org.openkilda.messaging.model.rule.FlowInstall.setOutputPort ( int  outputPort)

Sets output port.

Parameters
outputPortoutput port

Definition at line 119 of file FlowInstall.java.

◆ setOutputVlan()

void org.openkilda.messaging.model.rule.FlowInstall.setOutputVlan ( int  outputVlan)

Sets output vlan.

Parameters
outputVlanoutput vlan

Definition at line 137 of file FlowInstall.java.

◆ setOutputVlanType()

void org.openkilda.messaging.model.rule.FlowInstall.setOutputVlanType ( OutputVlanType  outputVlanType)

Sets output vlan type.

Parameters
outputVlanTypeoutput vlan type

Definition at line 155 of file FlowInstall.java.

◆ setPriority()

void org.openkilda.messaging.model.rule.FlowInstall.setPriority ( int  priority)

Sets priority.

Parameters
prioritypriority

Definition at line 191 of file FlowInstall.java.

◆ toString()

String org.openkilda.messaging.model.rule.FlowInstall.toString ( )

Definition at line 234 of file FlowInstall.java.


The documentation for this class was generated from the following file: