ImageApi

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

Method	HTTP request	Description
createImage	POST /CreateImage
createImageExportTask	POST /CreateImageExportTask
deleteImage	POST /DeleteImage
readImageExportTasks	POST /ReadImageExportTasks
readImages	POST /ReadImages
updateImage	POST /UpdateImage

createImage

CreateImageResponse createImage(createImageRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    CreateImageRequest createImageRequest = new CreateImageRequest(); // CreateImageRequest | 
    try {
      CreateImageResponse result = apiInstance.createImage(createImageRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#createImage");
      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
createImageRequest	CreateImageRequest		[optional]

Return type

CreateImageResponse

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

createImageExportTask

CreateImageExportTaskResponse createImageExportTask(createImageExportTaskRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    CreateImageExportTaskRequest createImageExportTaskRequest = new CreateImageExportTaskRequest(); // CreateImageExportTaskRequest | 
    try {
      CreateImageExportTaskResponse result = apiInstance.createImageExportTask(createImageExportTaskRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#createImageExportTask");
      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
createImageExportTaskRequest	CreateImageExportTaskRequest		[optional]

Return type

CreateImageExportTaskResponse

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

deleteImage

DeleteImageResponse deleteImage(deleteImageRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    DeleteImageRequest deleteImageRequest = new DeleteImageRequest(); // DeleteImageRequest | 
    try {
      DeleteImageResponse result = apiInstance.deleteImage(deleteImageRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#deleteImage");
      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
deleteImageRequest	DeleteImageRequest		[optional]

Return type

DeleteImageResponse

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

readImageExportTasks

ReadImageExportTasksResponse readImageExportTasks(readImageExportTasksRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    ReadImageExportTasksRequest readImageExportTasksRequest = new ReadImageExportTasksRequest(); // ReadImageExportTasksRequest | 
    try {
      ReadImageExportTasksResponse result = apiInstance.readImageExportTasks(readImageExportTasksRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#readImageExportTasks");
      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
readImageExportTasksRequest	ReadImageExportTasksRequest		[optional]

Return type

ReadImageExportTasksResponse

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

readImages

ReadImagesResponse readImages(readImagesRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    ReadImagesRequest readImagesRequest = new ReadImagesRequest(); // ReadImagesRequest | 
    try {
      ReadImagesResponse result = apiInstance.readImages(readImagesRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#readImages");
      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
readImagesRequest	ReadImagesRequest		[optional]

Return type

ReadImagesResponse

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

updateImage

UpdateImageResponse updateImage(updateImageRequest)

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

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

    ImageApi apiInstance = new ImageApi(defaultClient);
    UpdateImageRequest updateImageRequest = new UpdateImageRequest(); // UpdateImageRequest | 
    try {
      UpdateImageResponse result = apiInstance.updateImage(updateImageRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ImageApi#updateImage");
      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
updateImageRequest	UpdateImageRequest		[optional]

Return type

UpdateImageResponse

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

Files

ImageApi.md

Latest commit

History

ImageApi.md

File metadata and controls

ImageApi

createImage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createImageExportTask

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteImage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readImageExportTasks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readImages

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateImage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details