Skip to content

Latest commit

 

History

History
222 lines (154 loc) · 5.42 KB

EventLoopGroupApi.md

File metadata and controls

222 lines (154 loc) · 5.42 KB
Raw

EventLoopGroupApi

All URIs are relative to http://127.0.0.1:18776/api/v1/module

Method HTTP request Description
addEventLoopGroup POST /event-loop-group add event-loop-group
describeEventLoopGroup GET /event-loop-group/{elg}/detail get detailed info of one event-loop-group
getEventLoopGroup GET /event-loop-group/{elg} get event-loop-group
listEventLoopGroup GET /event-loop-group retrieve event-loop-group list
removeEventLoopGroup DELETE /event-loop-group/{elg} remove event-loop-group

addEventLoopGroup

addEventLoopGroup(body)

add event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopGroupApi;


EventLoopGroupApi apiInstance = new EventLoopGroupApi();
EventLoopGroupCreate body = new EventLoopGroupCreate(); // EventLoopGroupCreate | 
try {
    apiInstance.addEventLoopGroup(body);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopGroupApi#addEventLoopGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body EventLoopGroupCreate

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

describeEventLoopGroup

EventLoopGroupDetail describeEventLoopGroup(elg)

get detailed info of one event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopGroupApi;


EventLoopGroupApi apiInstance = new EventLoopGroupApi();
String elg = "elg_example"; // String | name of the event-loop-group
try {
    EventLoopGroupDetail result = apiInstance.describeEventLoopGroup(elg);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopGroupApi#describeEventLoopGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group

Return type

EventLoopGroupDetail

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getEventLoopGroup

EventLoopGroup getEventLoopGroup(elg)

get event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopGroupApi;


EventLoopGroupApi apiInstance = new EventLoopGroupApi();
String elg = "elg_example"; // String | name of the event-loop-group
try {
    EventLoopGroup result = apiInstance.getEventLoopGroup(elg);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopGroupApi#getEventLoopGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group

Return type

EventLoopGroup

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

listEventLoopGroup

List<EventLoopGroup> listEventLoopGroup()

retrieve event-loop-group list

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopGroupApi;


EventLoopGroupApi apiInstance = new EventLoopGroupApi();
try {
    List<EventLoopGroup> result = apiInstance.listEventLoopGroup();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopGroupApi#listEventLoopGroup");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<EventLoopGroup>

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeEventLoopGroup

removeEventLoopGroup(elg)

remove event-loop-group

Example

// Import classes:
//import vproxy.client.ApiException;
//import vproxy.client.model.EventLoopGroupApi;


EventLoopGroupApi apiInstance = new EventLoopGroupApi();
String elg = "elg_example"; // String | name of the event-loop-group
try {
    apiInstance.removeEventLoopGroup(elg);
} catch (ApiException e) {
    System.err.println("Exception when calling EventLoopGroupApi#removeEventLoopGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
elg String name of the event-loop-group

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined