Open Kilda Java Documentation
org.openkilda.messaging.payload.flow.FlowPayload Class Reference
Inheritance diagram for org.openkilda.messaging.payload.flow.FlowPayload:

Public Member Functions

 FlowPayload (@JsonProperty(Utils.FLOW_ID) String id, @JsonProperty("source") FlowEndpointPayload source, @JsonProperty("destination") FlowEndpointPayload destination, @JsonProperty("maximum-bandwidth") long maximumBandwidth, @JsonProperty("ignore_bandwidth") Boolean ignoreBandwidth, @JsonProperty("description") String description, @JsonProperty("last-updated") String lastUpdated, @JsonProperty("status") String status)
 
String getId ()
 
void setId (String id)
 
FlowEndpointPayload getSource ()
 
void setSource (FlowEndpointPayload source)
 
FlowEndpointPayload getDestination ()
 
void setDestination (FlowEndpointPayload destination)
 
long getMaximumBandwidth ()
 
void setMaximumBandwidth (long maximumBandwidth)
 
boolean isIgnoreBandwidth ()
 
void setIgnoreBandwidth (Boolean ignoreBandwidth)
 
String getDescription ()
 
void setDescription (String description)
 
String getLastUpdated ()
 
void setLastUpdated (String lastUpdated)
 
String getStatus ()
 
void setStatus (String status)
 
String toString ()
 
boolean equals (Object obj)
 
int hashCode ()
 

Detailed Description

Flow representation class.

Definition at line 38 of file FlowPayload.java.

Constructor & Destructor Documentation

◆ FlowPayload()

org.openkilda.messaging.payload.flow.FlowPayload.FlowPayload ( @JsonProperty(Utils.FLOW_ID) String  id,
@JsonProperty("source") FlowEndpointPayload  source,
@JsonProperty("destination") FlowEndpointPayload  destination,
@JsonProperty("maximum-bandwidth") long  maximumBandwidth,
@JsonProperty("ignore_bandwidth") Boolean  ignoreBandwidth,
@JsonProperty("description") String  description,
@JsonProperty("last-updated") String  lastUpdated,
@JsonProperty("status") String  status 
)

Instance constructor.

Parameters
idflow id
sourceflow source
destinationflow destination
maximumBandwidthflow maximum bandwidth
ignoreBandwidthshould ignore bandwidth in path computation
descriptionflow description
lastUpdatedflow last updated timestamp

Definition at line 101 of file FlowPayload.java.

Member Function Documentation

◆ equals()

boolean org.openkilda.messaging.payload.flow.FlowPayload.equals ( Object  obj)

Definition at line 283 of file FlowPayload.java.

◆ getDescription()

String org.openkilda.messaging.payload.flow.FlowPayload.getDescription ( )

Gets flow description.

Returns
flow description

Definition at line 225 of file FlowPayload.java.

◆ getDestination()

FlowEndpointPayload org.openkilda.messaging.payload.flow.FlowPayload.getDestination ( )

Gets destination endpoint.

Returns
destination endpoint

Definition at line 166 of file FlowPayload.java.

◆ getId()

String org.openkilda.messaging.payload.flow.FlowPayload.getId ( )

Gets flow id.

Returns
flow id

Definition at line 124 of file FlowPayload.java.

◆ getLastUpdated()

String org.openkilda.messaging.payload.flow.FlowPayload.getLastUpdated ( )

Gets last flow updated timestamp.

Returns
last flow updated timestamp

Definition at line 243 of file FlowPayload.java.

◆ getMaximumBandwidth()

long org.openkilda.messaging.payload.flow.FlowPayload.getMaximumBandwidth ( )

Gets maximum-bandwidth.

Returns
maximum-bandwidth

Definition at line 187 of file FlowPayload.java.

◆ getSource()

FlowEndpointPayload org.openkilda.messaging.payload.flow.FlowPayload.getSource ( )

Gets source endpoint.

Returns
source endpoint

Definition at line 145 of file FlowPayload.java.

◆ getStatus()

String org.openkilda.messaging.payload.flow.FlowPayload.getStatus ( )

Definition at line 256 of file FlowPayload.java.

◆ hashCode()

int org.openkilda.messaging.payload.flow.FlowPayload.hashCode ( )

Definition at line 305 of file FlowPayload.java.

◆ isIgnoreBandwidth()

boolean org.openkilda.messaging.payload.flow.FlowPayload.isIgnoreBandwidth ( )

Definition at line 204 of file FlowPayload.java.

◆ setDescription()

void org.openkilda.messaging.payload.flow.FlowPayload.setDescription ( String  description)

Sets flow description.

Parameters
descriptionflow description

Definition at line 234 of file FlowPayload.java.

◆ setDestination()

void org.openkilda.messaging.payload.flow.FlowPayload.setDestination ( FlowEndpointPayload  destination)

Sets destination endpoint.

Parameters
destinationdestination endpoint

Definition at line 175 of file FlowPayload.java.

◆ setId()

void org.openkilda.messaging.payload.flow.FlowPayload.setId ( String  id)

Sets flow id.

Parameters
idflow id

Definition at line 133 of file FlowPayload.java.

◆ setIgnoreBandwidth()

void org.openkilda.messaging.payload.flow.FlowPayload.setIgnoreBandwidth ( Boolean  ignoreBandwidth)

Sets ignore bandwidth flag.

Parameters
ignoreBandwidthflag value

Definition at line 213 of file FlowPayload.java.

◆ setLastUpdated()

void org.openkilda.messaging.payload.flow.FlowPayload.setLastUpdated ( String  lastUpdated)

Sets last flow updated timestamp.

Parameters
lastUpdatedflow updated timestamp

Definition at line 252 of file FlowPayload.java.

◆ setMaximumBandwidth()

void org.openkilda.messaging.payload.flow.FlowPayload.setMaximumBandwidth ( long  maximumBandwidth)

Sets maximum bandwidth.

Parameters
maximumBandwidthmaximum bandwidth

Definition at line 196 of file FlowPayload.java.

◆ setSource()

void org.openkilda.messaging.payload.flow.FlowPayload.setSource ( FlowEndpointPayload  source)

Sets source endpoint.

Parameters
sourcesource endpoint

Definition at line 154 of file FlowPayload.java.

◆ setStatus()

void org.openkilda.messaging.payload.flow.FlowPayload.setStatus ( String  status)

Definition at line 260 of file FlowPayload.java.

◆ toString()

String org.openkilda.messaging.payload.flow.FlowPayload.toString ( )

Definition at line 268 of file FlowPayload.java.


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