Skip to content

Latest commit

 

History

History
218 lines (166 loc) · 8 KB

ClientGatewayApi.md

File metadata and controls

218 lines (166 loc) · 8 KB

ClientGatewayApi

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

Method HTTP request Description
createClientGateway POST /CreateClientGateway
deleteClientGateway POST /DeleteClientGateway
readClientGateways POST /ReadClientGateways

createClientGateway

CreateClientGatewayResponse createClientGateway(createClientGatewayRequest)

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.ClientGatewayApi;

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");

    ClientGatewayApi apiInstance = new ClientGatewayApi(defaultClient);
    CreateClientGatewayRequest createClientGatewayRequest = new CreateClientGatewayRequest(); // CreateClientGatewayRequest | 
    try {
      CreateClientGatewayResponse result = apiInstance.createClientGateway(createClientGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ClientGatewayApi#createClientGateway");
      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
createClientGatewayRequest CreateClientGatewayRequest [optional]

Return type

CreateClientGatewayResponse

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). -

deleteClientGateway

DeleteClientGatewayResponse deleteClientGateway(deleteClientGatewayRequest)

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.ClientGatewayApi;

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");

    ClientGatewayApi apiInstance = new ClientGatewayApi(defaultClient);
    DeleteClientGatewayRequest deleteClientGatewayRequest = new DeleteClientGatewayRequest(); // DeleteClientGatewayRequest | 
    try {
      DeleteClientGatewayResponse result = apiInstance.deleteClientGateway(deleteClientGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ClientGatewayApi#deleteClientGateway");
      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
deleteClientGatewayRequest DeleteClientGatewayRequest [optional]

Return type

DeleteClientGatewayResponse

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). -

readClientGateways

ReadClientGatewaysResponse readClientGateways(readClientGatewaysRequest)

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.ClientGatewayApi;

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");

    ClientGatewayApi apiInstance = new ClientGatewayApi(defaultClient);
    ReadClientGatewaysRequest readClientGatewaysRequest = new ReadClientGatewaysRequest(); // ReadClientGatewaysRequest | 
    try {
      ReadClientGatewaysResponse result = apiInstance.readClientGateways(readClientGatewaysRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ClientGatewayApi#readClientGateways");
      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
readClientGatewaysRequest ReadClientGatewaysRequest [optional]

Return type

ReadClientGatewaysResponse

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). -