org.wso2.am.integration.clients.publisher.api.v1

Class ImportExportApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.ImportExportApi

public class ImportExportApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ImportExportApi()
ImportExportApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	apisExportGet(String apiId, 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	apisExportGetAsync(String apiId, 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	apisExportGetCall(String apiId, String name, String version, String providerName, String format, Boolean preserveStatus, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisExportGet
ApiResponse<File>	apisExportGetWithHttpInfo(String apiId, 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	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportExportApi

public ImportExportApi()

ImportExportApi

public ImportExportApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisExportGetCall

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

Build call for apisExportGet

Parameters:

apiId - UUID of the API (optional)

name - API Name (optional)

version - Version of the API (optional)

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

apisExportGet

public File apisExportGet(String apiId,
                          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:

apiId - UUID of the API (optional)

name - API Name (optional)

version - Version of the API (optional)

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

apisExportGetWithHttpInfo

public ApiResponse<File> apisExportGetWithHttpInfo(String apiId,
                                                   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:

apiId - UUID of the API (optional)

name - API Name (optional)

version - Version of the API (optional)

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

apisExportGetAsync

public com.squareup.okhttp.Call apisExportGetAsync(String apiId,
                                                   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:

apiId - UUID of the API (optional)

name - API Name (optional)

version - Version of the API (optional)

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