Skip to content

AcceleratorServiceApi.md

Latest commit

 

History

History
385 lines (301 loc) · 12.9 KB

AcceleratorServiceApi.md

File metadata and controls

385 lines (301 loc) · 12.9 KB

AcceleratorServiceApi

All URIs are relative to https://api.subspace.com

Method HTTP request Description
acceleratorServiceCreate POST /v1/accelerator
acceleratorServiceDelete DELETE /v1/accelerator/{id}
acceleratorServiceGet GET /v1/accelerator/{id}
acceleratorServiceList GET /v1/accelerator
acceleratorServiceUpdate PUT /v1/accelerator/{id}

acceleratorServiceCreate

V1Accelerator acceleratorServiceCreate(body, idempotencyKey)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AcceleratorServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.subspace.com");
    
    // Configure OAuth2 access token for authorization: accessCode
    OAuth accessCode = (OAuth) defaultClient.getAuthentication("accessCode");
    accessCode.setAccessToken("YOUR ACCESS TOKEN");

    AcceleratorServiceApi apiInstance = new AcceleratorServiceApi(defaultClient);
    Body body = new Body(); // Body | Required parameters to create a new PacketAccelerator.
    String idempotencyKey = "idempotencyKey_example"; // String | Value is the returned etag of a get request.  If a retry sends an Idempotency-Key that has been seen before, the existing accelerator is returned with the status code of 200
    try {
      V1Accelerator result = apiInstance.acceleratorServiceCreate(body, idempotencyKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AcceleratorServiceApi#acceleratorServiceCreate");
      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
body Body Required parameters to create a new PacketAccelerator.
idempotencyKey String Value is the returned etag of a get request. If a retry sends an Idempotency-Key that has been seen before, the existing accelerator is returned with the status code of 200 [optional]

Return type

V1Accelerator

Authorization

accessCode

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -
401 Access token is missing or invalid -
402 Quota exceeded -
403 Not authorized -
404 Returned when the resource does not exist. -
429 Too many client requests -
201 Accelerator created -
0 An unexpected error response. -

acceleratorServiceDelete

Object acceleratorServiceDelete(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AcceleratorServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.subspace.com");
    
    // Configure OAuth2 access token for authorization: accessCode
    OAuth accessCode = (OAuth) defaultClient.getAuthentication("accessCode");
    accessCode.setAccessToken("YOUR ACCESS TOKEN");

    AcceleratorServiceApi apiInstance = new AcceleratorServiceApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      Object result = apiInstance.acceleratorServiceDelete(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AcceleratorServiceApi#acceleratorServiceDelete");
      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
id String

Return type

Object

Authorization

accessCode

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -
401 Access token is missing or invalid -
402 Quota exceeded -
403 Not authorized -
404 Returned when the resource does not exist. -
429 Too many client requests -
0 An unexpected error response. -

acceleratorServiceGet

V1Accelerator acceleratorServiceGet(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AcceleratorServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.subspace.com");
    
    // Configure OAuth2 access token for authorization: accessCode
    OAuth accessCode = (OAuth) defaultClient.getAuthentication("accessCode");
    accessCode.setAccessToken("YOUR ACCESS TOKEN");

    AcceleratorServiceApi apiInstance = new AcceleratorServiceApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      V1Accelerator result = apiInstance.acceleratorServiceGet(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AcceleratorServiceApi#acceleratorServiceGet");
      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
id String

Return type

V1Accelerator

Authorization

accessCode

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. * ETag - Include in the headers of a subsequent PUT to avoid concurrency issues
400 Bad request -
401 Access token is missing or invalid -
402 Quota exceeded -
403 Not authorized -
404 Returned when the resource does not exist. -
429 Too many client requests -
0 An unexpected error response. -

acceleratorServiceList

V1ListAcceleratorResponse acceleratorServiceList(before, limit, name)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AcceleratorServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.subspace.com");
    
    // Configure OAuth2 access token for authorization: accessCode
    OAuth accessCode = (OAuth) defaultClient.getAuthentication("accessCode");
    accessCode.setAccessToken("YOUR ACCESS TOKEN");

    AcceleratorServiceApi apiInstance = new AcceleratorServiceApi(defaultClient);
    String before = "before_example"; // String | 
    Long limit = 56L; // Long | 
    String name = "name_example"; // String | 
    try {
      V1ListAcceleratorResponse result = apiInstance.acceleratorServiceList(before, limit, name);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AcceleratorServiceApi#acceleratorServiceList");
      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
before String [optional]
limit Long [optional]
name String [optional]

Return type

V1ListAcceleratorResponse

Authorization

accessCode

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -
401 Access token is missing or invalid -
402 Quota exceeded -
403 Not authorized -
404 Returned when the resource does not exist. -
429 Too many client requests -
0 An unexpected error response. -

acceleratorServiceUpdate

V1Accelerator acceleratorServiceUpdate(id, body1, ifMatch)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AcceleratorServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.subspace.com");
    
    // Configure OAuth2 access token for authorization: accessCode
    OAuth accessCode = (OAuth) defaultClient.getAuthentication("accessCode");
    accessCode.setAccessToken("YOUR ACCESS TOKEN");

    AcceleratorServiceApi apiInstance = new AcceleratorServiceApi(defaultClient);
    String id = "id_example"; // String | 
    Body1 body1 = new Body1(); // Body1 | Parameters to update an existing PacketAccelerator
    Integer ifMatch = 56; // Integer | 
    try {
      V1Accelerator result = apiInstance.acceleratorServiceUpdate(id, body1, ifMatch);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AcceleratorServiceApi#acceleratorServiceUpdate");
      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
id String
body1 Body1 Parameters to update an existing PacketAccelerator
ifMatch Integer [optional]

Return type

V1Accelerator

Authorization

accessCode

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
400 Bad request -
401 Access token is missing or invalid -
402 Quota exceeded -
403 Not authorized -
404 Returned when the resource does not exist. -
429 Too many client requests -
409 Edit conflict -
0 An unexpected error response. -