org.wso2.am.integration.clients.admin.api

Class ApiIndividualApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.ApiIndividualApi

public class ApiIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiIndividualApi()
ApiIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	exportApiGet(String name, String version, String providerName, String format, Boolean preserveStatus) Export an API This operation can be used to export the details of a particular API as a zip file.
com.squareup.okhttp.Call	exportApiGetAsync(String name, String version, String providerName, String format, Boolean preserveStatus, ApiCallback<File> callback) Export an API (asynchronously) This operation can be used to export the details of a particular API as a zip file.
com.squareup.okhttp.Call	exportApiGetCall(String name, String version, String providerName, String format, Boolean preserveStatus, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for exportApiGet
ApiResponse<File>	exportApiGetWithHttpInfo(String name, String version, String providerName, String format, Boolean preserveStatus) Export an API This operation can be used to export the details of a particular API as a zip file.
ApiClient	getApiClient()
void	importApiPost(File file, Boolean preserveProvider, Boolean overwrite) Import an API This operation can be used to import an API.
com.squareup.okhttp.Call	importApiPostAsync(File file, Boolean preserveProvider, Boolean overwrite, ApiCallback<Void> callback) Import an API (asynchronously) This operation can be used to import an API.
com.squareup.okhttp.Call	importApiPostCall(File file, Boolean preserveProvider, Boolean overwrite, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for importApiPost
ApiResponse<Void>	importApiPostWithHttpInfo(File file, Boolean preserveProvider, Boolean overwrite) Import an API This operation can be used to import an API.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiIndividualApi

public ApiIndividualApi()

ApiIndividualApi

public ApiIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

exportApiGetCall

public com.squareup.okhttp.Call exportApiGetCall(String name,
                                                 String version,
                                                 String providerName,
                                                 String format,
                                                 Boolean preserveStatus,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for exportApiGet

Parameters:

name - API Name (required)

version - Version of the API (required)

providerName - Provider name of the API (optional)

format - Format of output documents. Can be YAML or JSON. (optional)

preserveStatus - Preserve API Status on export (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportApiGet

public File exportApiGet(String name,
                         String version,
                         String providerName,
                         String format,
                         Boolean preserveStatus)
                  throws ApiException

Export an API This operation can be used to export the details of a particular API as a zip file.

Parameters:

name - API Name (required)

version - Version of the API (required)

providerName - Provider name of the API (optional)

format - Format of output documents. Can be YAML or JSON. (optional)

preserveStatus - Preserve API Status on export (optional)

Returns:

File

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

exportApiGetWithHttpInfo

public ApiResponse<File> exportApiGetWithHttpInfo(String name,
                                                  String version,
                                                  String providerName,
                                                  String format,
                                                  Boolean preserveStatus)
                                           throws ApiException

Export an API This operation can be used to export the details of a particular API as a zip file.

Parameters:

name - API Name (required)

version - Version of the API (required)

providerName - Provider name of the API (optional)

format - Format of output documents. Can be YAML or JSON. (optional)

preserveStatus - Preserve API Status on export (optional)

Returns:

ApiResponse<File>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

exportApiGetAsync

public com.squareup.okhttp.Call exportApiGetAsync(String name,
                                                  String version,
                                                  String providerName,
                                                  String format,
                                                  Boolean preserveStatus,
                                                  ApiCallback<File> callback)
                                           throws ApiException

Export an API (asynchronously) This operation can be used to export the details of a particular API as a zip file.

Parameters:

name - API Name (required)

version - Version of the API (required)

providerName - Provider name of the API (optional)

format - Format of output documents. Can be YAML or JSON. (optional)

preserveStatus - Preserve API Status on export (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

importApiPostCall

public com.squareup.okhttp.Call importApiPostCall(File file,
                                                  Boolean preserveProvider,
                                                  Boolean overwrite,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for importApiPost

Parameters:

file - Zip archive consisting on exported api configuration (required)

preserveProvider - Preserve Original Provider of the API. This is the user choice to keep or replace the API provider. (optional)

overwrite - Whether to update the API or not. This is used when updating already existing APIs. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importApiPost

public void importApiPost(File file,
                          Boolean preserveProvider,
                          Boolean overwrite)
                   throws ApiException

Import an API This operation can be used to import an API.

Parameters:

file - Zip archive consisting on exported api configuration (required)

preserveProvider - Preserve Original Provider of the API. This is the user choice to keep or replace the API provider. (optional)

overwrite - Whether to update the API or not. This is used when updating already existing APIs. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

importApiPostWithHttpInfo

public ApiResponse<Void> importApiPostWithHttpInfo(File file,
                                                   Boolean preserveProvider,
                                                   Boolean overwrite)
                                            throws ApiException

Import an API This operation can be used to import an API.

Parameters:

file - Zip archive consisting on exported api configuration (required)

preserveProvider - Preserve Original Provider of the API. This is the user choice to keep or replace the API provider. (optional)

overwrite - Whether to update the API or not. This is used when updating already existing APIs. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

importApiPostAsync

public com.squareup.okhttp.Call importApiPostAsync(File file,
                                                   Boolean preserveProvider,
                                                   Boolean overwrite,
                                                   ApiCallback<Void> callback)
                                            throws ApiException

Import an API (asynchronously) This operation can be used to import an API.

Parameters:

file - Zip archive consisting on exported api configuration (required)

preserveProvider - Preserve Original Provider of the API. This is the user choice to keep or replace the API provider. (optional)

overwrite - Whether to update the API or not. This is used when updating already existing APIs. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object