Skip to content

Latest commit

 

History

History
227 lines (175 loc) · 7.94 KB

RouteApi.md

File metadata and controls

227 lines (175 loc) · 7.94 KB
Raw

RouteApi

All URIs are relative to https://api.eu-west-2.outscale.com/api/v1

Method HTTP request Description
createRoute POST /CreateRoute
deleteRoute POST /DeleteRoute
updateRoute POST /UpdateRoute

createRoute

CreateRouteResponse createRoute(createRouteRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.RouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    RouteApi apiInstance = new RouteApi(defaultClient);
    CreateRouteRequest createRouteRequest = new CreateRouteRequest(); // CreateRouteRequest | 
    try {
      CreateRouteResponse result = apiInstance.createRoute(createRouteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RouteApi#createRoute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
createRouteRequest CreateRouteRequest [optional]

Return type

CreateRouteResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -

deleteRoute

DeleteRouteResponse deleteRoute(deleteRouteRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.RouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    RouteApi apiInstance = new RouteApi(defaultClient);
    DeleteRouteRequest deleteRouteRequest = new DeleteRouteRequest(); // DeleteRouteRequest | 
    try {
      DeleteRouteResponse result = apiInstance.deleteRoute(deleteRouteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RouteApi#deleteRoute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
deleteRouteRequest DeleteRouteRequest [optional]

Return type

DeleteRouteResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -

updateRoute

UpdateRouteResponse updateRoute(updateRouteRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.RouteApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    RouteApi apiInstance = new RouteApi(defaultClient);
    UpdateRouteRequest updateRouteRequest = new UpdateRouteRequest(); // UpdateRouteRequest | 
    try {
      UpdateRouteResponse result = apiInstance.updateRoute(updateRouteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RouteApi#updateRoute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
updateRouteRequest UpdateRouteRequest [optional]

Return type

UpdateRouteResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The HTTP 200 response (OK). -
400 The HTTP 400 response (Bad Request). -
401 The HTTP 401 response (Unauthorized). -
500 The HTTP 500 response (Internal Server Error). -