Open Kilda Java Documentation
org.openkilda.northbound.controller.LinkController Class Reference

Public Member Functions

List< LinkDtogetLinks ()
 
List< LinkPropsDtogetLinkProps (@RequestParam(value="src_switch", required=false) SwitchId srcSwitch, @RequestParam(value="src_port", required=false) Integer srcPort, @RequestParam(value="dst_switch", required=false) SwitchId dstSwitch, @RequestParam(value="dst_port", required=false) Integer dstPort)
 
BatchResults putLinkProps ( @RequestBody List< LinkPropsDto > keysAndProps)
 
BatchResults delLinkProps ( @RequestBody List< LinkPropsDto > keysAndProps)
 

Detailed Description

REST Controller for links.

Definition at line 57 of file LinkController.java.

Member Function Documentation

◆ delLinkProps()

BatchResults org.openkilda.northbound.controller.LinkController.delLinkProps ( @RequestBody List< LinkPropsDto keysAndProps)

Delete link properties from the static link properties table.

Parameters
keysAndPropsif null, get all link props. Otherwise, the link props that much the primary keys.
Returns
result of the processing.

Definition at line 119 of file LinkController.java.

◆ getLinkProps()

List<LinkPropsDto> org.openkilda.northbound.controller.LinkController.getLinkProps ( @RequestParam(value="src_switch", required=false) SwitchId  srcSwitch,
@RequestParam(value="src_port", required=false) Integer  srcPort,
@RequestParam(value="dst_switch", required=false) SwitchId  dstSwitch,
@RequestParam(value="dst_port", required=false) Integer  dstPort 
)

Get link properties from the static link properties table.

Returns
list of link properties.

Definition at line 85 of file LinkController.java.

◆ getLinks()

List<LinkDto> org.openkilda.northbound.controller.LinkController.getLinks ( )

Get all available links.

Returns
list of links.

Definition at line 70 of file LinkController.java.

◆ putLinkProps()

BatchResults org.openkilda.northbound.controller.LinkController.putLinkProps ( @RequestBody List< LinkPropsDto keysAndProps)

Create/Update link properties in the static link properties table.

Parameters
keysAndPropsif null, get all link props. Otherwise, the link props that much the primary keys.
Returns
result of the processing.

Definition at line 103 of file LinkController.java.


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