VirtualGatewayApi

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

Method	HTTP request	Description
createVirtualGateway	POST /CreateVirtualGateway
deleteVirtualGateway	POST /DeleteVirtualGateway
linkVirtualGateway	POST /LinkVirtualGateway
readVirtualGateways	POST /ReadVirtualGateways
unlinkVirtualGateway	POST /UnlinkVirtualGateway
updateRoutePropagation	POST /UpdateRoutePropagation

createVirtualGateway

CreateVirtualGatewayResponse createVirtualGateway(createVirtualGatewayRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    CreateVirtualGatewayRequest createVirtualGatewayRequest = new CreateVirtualGatewayRequest(); // CreateVirtualGatewayRequest | 
    try {
      CreateVirtualGatewayResponse result = apiInstance.createVirtualGateway(createVirtualGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#createVirtualGateway");
      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
createVirtualGatewayRequest	CreateVirtualGatewayRequest		[optional]

Return type

CreateVirtualGatewayResponse

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

deleteVirtualGateway

DeleteVirtualGatewayResponse deleteVirtualGateway(deleteVirtualGatewayRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    DeleteVirtualGatewayRequest deleteVirtualGatewayRequest = new DeleteVirtualGatewayRequest(); // DeleteVirtualGatewayRequest | 
    try {
      DeleteVirtualGatewayResponse result = apiInstance.deleteVirtualGateway(deleteVirtualGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#deleteVirtualGateway");
      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
deleteVirtualGatewayRequest	DeleteVirtualGatewayRequest		[optional]

Return type

DeleteVirtualGatewayResponse

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

linkVirtualGateway

LinkVirtualGatewayResponse linkVirtualGateway(linkVirtualGatewayRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    LinkVirtualGatewayRequest linkVirtualGatewayRequest = new LinkVirtualGatewayRequest(); // LinkVirtualGatewayRequest | 
    try {
      LinkVirtualGatewayResponse result = apiInstance.linkVirtualGateway(linkVirtualGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#linkVirtualGateway");
      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
linkVirtualGatewayRequest	LinkVirtualGatewayRequest		[optional]

Return type

LinkVirtualGatewayResponse

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

readVirtualGateways

ReadVirtualGatewaysResponse readVirtualGateways(readVirtualGatewaysRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    ReadVirtualGatewaysRequest readVirtualGatewaysRequest = new ReadVirtualGatewaysRequest(); // ReadVirtualGatewaysRequest | 
    try {
      ReadVirtualGatewaysResponse result = apiInstance.readVirtualGateways(readVirtualGatewaysRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#readVirtualGateways");
      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
readVirtualGatewaysRequest	ReadVirtualGatewaysRequest		[optional]

Return type

ReadVirtualGatewaysResponse

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

unlinkVirtualGateway

UnlinkVirtualGatewayResponse unlinkVirtualGateway(unlinkVirtualGatewayRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    UnlinkVirtualGatewayRequest unlinkVirtualGatewayRequest = new UnlinkVirtualGatewayRequest(); // UnlinkVirtualGatewayRequest | 
    try {
      UnlinkVirtualGatewayResponse result = apiInstance.unlinkVirtualGateway(unlinkVirtualGatewayRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#unlinkVirtualGateway");
      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
unlinkVirtualGatewayRequest	UnlinkVirtualGatewayRequest		[optional]

Return type

UnlinkVirtualGatewayResponse

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

updateRoutePropagation

UpdateRoutePropagationResponse updateRoutePropagation(updateRoutePropagationRequest)

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

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

    VirtualGatewayApi apiInstance = new VirtualGatewayApi(defaultClient);
    UpdateRoutePropagationRequest updateRoutePropagationRequest = new UpdateRoutePropagationRequest(); // UpdateRoutePropagationRequest | 
    try {
      UpdateRoutePropagationResponse result = apiInstance.updateRoutePropagation(updateRoutePropagationRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualGatewayApi#updateRoutePropagation");
      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
updateRoutePropagationRequest	UpdateRoutePropagationRequest		[optional]

Return type

UpdateRoutePropagationResponse

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

Files

VirtualGatewayApi.md

Latest commit

History

VirtualGatewayApi.md

File metadata and controls

VirtualGatewayApi

createVirtualGateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteVirtualGateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

linkVirtualGateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readVirtualGateways

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unlinkVirtualGateway

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateRoutePropagation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details