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	exportAPI(String apiId, String name, String version, String revisionNumber, String providerName, String format, Boolean preserveStatus, Boolean latestRevision) Export an API This operation can be used to export the details of a particular API as a zip file.
okhttp3.Call	exportAPIAsync(String apiId, String name, String version, String revisionNumber, String providerName, String format, Boolean preserveStatus, Boolean latestRevision, ApiCallback<File> _callback) Export an API (asynchronously) This operation can be used to export the details of a particular API as a zip file.
okhttp3.Call	exportAPICall(String apiId, String name, String version, String revisionNumber, String providerName, String format, Boolean preserveStatus, Boolean latestRevision, ApiCallback _callback) Build call for exportAPI
File	exportAPIProduct(String name, String version, String providerName, String revisionNumber, String format, Boolean preserveStatus, Boolean latestRevision) Export an API Product This operation can be used to export the details of a particular API Product as a zip file.
okhttp3.Call	exportAPIProductAsync(String name, String version, String providerName, String revisionNumber, String format, Boolean preserveStatus, Boolean latestRevision, ApiCallback<File> _callback) Export an API Product (asynchronously) This operation can be used to export the details of a particular API Product as a zip file.
okhttp3.Call	exportAPIProductCall(String name, String version, String providerName, String revisionNumber, String format, Boolean preserveStatus, Boolean latestRevision, ApiCallback _callback) Build call for exportAPIProduct
ApiResponse<File>	exportAPIProductWithHttpInfo(String name, String version, String providerName, String revisionNumber, String format, Boolean preserveStatus, Boolean latestRevision) Export an API Product This operation can be used to export the details of a particular API Product as a zip file.
ApiResponse<File>	exportAPIWithHttpInfo(String apiId, String name, String version, String revisionNumber, String providerName, String format, Boolean preserveStatus, Boolean latestRevision) Export an API This operation can be used to export the details of a particular API as a zip file.
ApiClient	getApiClient()
void	importAPI(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean overwrite) Import an API This operation can be used to import an API.
okhttp3.Call	importAPIAsync(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean overwrite, ApiCallback<Void> _callback) Import an API (asynchronously) This operation can be used to import an API.
okhttp3.Call	importAPICall(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean overwrite, ApiCallback _callback) Build call for importAPI
void	importAPIProduct(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs) Import an API Product This operation can be used to import an API Product.
okhttp3.Call	importAPIProductAsync(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs, ApiCallback<Void> _callback) Import an API Product (asynchronously) This operation can be used to import an API Product.
okhttp3.Call	importAPIProductCall(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs, ApiCallback _callback) Build call for importAPIProduct
ApiResponse<Void>	importAPIProductWithHttpInfo(File file, Boolean preserveProvider, Boolean rotateRevision, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs) Import an API Product This operation can be used to import an API Product.
ApiResponse<Void>	importAPIWithHttpInfo(File file, Boolean preserveProvider, Boolean rotateRevision, 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

ImportExportApi

public ImportExportApi()

ImportExportApi

public ImportExportApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

exportAPICall

public okhttp3.Call exportAPICall(String apiId,
                                  String name,
                                  String version,
                                  String revisionNumber,
                                  String providerName,
                                  String format,
                                  Boolean preserveStatus,
                                  Boolean latestRevision,
                                  ApiCallback _callback)
                           throws ApiException

Build call for exportAPI

Parameters:

apiId - UUID of the API (optional)

name - API Name (optional)

version - Version of the API (optional)

revisionNumber - Revision number of the API artifact (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)

latestRevision - Export the latest revision of the API (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportAPI

public File exportAPI(String apiId,
                      String name,
                      String version,
                      String revisionNumber,
                      String providerName,
                      String format,
                      Boolean preserveStatus,
                      Boolean latestRevision)
               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)

revisionNumber - Revision number of the API artifact (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)

latestRevision - Export the latest revision of the API (optional, default to false)

Returns:

File

Throws:

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

exportAPIWithHttpInfo

public ApiResponse<File> exportAPIWithHttpInfo(String apiId,
                                               String name,
                                               String version,
                                               String revisionNumber,
                                               String providerName,
                                               String format,
                                               Boolean preserveStatus,
                                               Boolean latestRevision)
                                        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)

revisionNumber - Revision number of the API artifact (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)

latestRevision - Export the latest revision of the API (optional, default to false)

Returns:

ApiResponse<File>

Throws:

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

exportAPIAsync

public okhttp3.Call exportAPIAsync(String apiId,
                                   String name,
                                   String version,
                                   String revisionNumber,
                                   String providerName,
                                   String format,
                                   Boolean preserveStatus,
                                   Boolean latestRevision,
                                   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)

revisionNumber - Revision number of the API artifact (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)

latestRevision - Export the latest revision of the API (optional, default to false)

_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

exportAPIProductCall

public okhttp3.Call exportAPIProductCall(String name,
                                         String version,
                                         String providerName,
                                         String revisionNumber,
                                         String format,
                                         Boolean preserveStatus,
                                         Boolean latestRevision,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for exportAPIProduct

Parameters:

name - API Product Name (optional)

version - Version of the API Product (optional)

providerName - Provider name of the API Product (optional)

revisionNumber - Revision number of the API Product (optional)

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

preserveStatus - Preserve API Product Status on export (optional)

latestRevision - Export the latest revision of the API Product (optional, default to false)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportAPIProduct

public File exportAPIProduct(String name,
                             String version,
                             String providerName,
                             String revisionNumber,
                             String format,
                             Boolean preserveStatus,
                             Boolean latestRevision)
                      throws ApiException

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

Parameters:

name - API Product Name (optional)

version - Version of the API Product (optional)

providerName - Provider name of the API Product (optional)

revisionNumber - Revision number of the API Product (optional)

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

preserveStatus - Preserve API Product Status on export (optional)

latestRevision - Export the latest revision of the API Product (optional, default to false)

Returns:

File

Throws:

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

exportAPIProductWithHttpInfo

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

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

Parameters:

name - API Product Name (optional)

version - Version of the API Product (optional)

providerName - Provider name of the API Product (optional)

revisionNumber - Revision number of the API Product (optional)

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

preserveStatus - Preserve API Product Status on export (optional)

latestRevision - Export the latest revision of the API Product (optional, default to false)

Returns:

ApiResponse<File>

Throws:

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

exportAPIProductAsync

public okhttp3.Call exportAPIProductAsync(String name,
                                          String version,
                                          String providerName,
                                          String revisionNumber,
                                          String format,
                                          Boolean preserveStatus,
                                          Boolean latestRevision,
                                          ApiCallback<File> _callback)
                                   throws ApiException

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

Parameters:

name - API Product Name (optional)

version - Version of the API Product (optional)

providerName - Provider name of the API Product (optional)

revisionNumber - Revision number of the API Product (optional)

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

preserveStatus - Preserve API Product Status on export (optional)

latestRevision - Export the latest revision of the API Product (optional, default to false)

_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

importAPICall

public okhttp3.Call importAPICall(File file,
                                  Boolean preserveProvider,
                                  Boolean rotateRevision,
                                  Boolean overwrite,
                                  ApiCallback _callback)
                           throws ApiException

Build call for importAPI

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)

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (optional)

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importAPI

public void importAPI(File file,
                      Boolean preserveProvider,
                      Boolean rotateRevision,
                      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)

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (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

importAPIWithHttpInfo

public ApiResponse<Void> importAPIWithHttpInfo(File file,
                                               Boolean preserveProvider,
                                               Boolean rotateRevision,
                                               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)

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (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

importAPIAsync

public okhttp3.Call importAPIAsync(File file,
                                   Boolean preserveProvider,
                                   Boolean rotateRevision,
                                   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)

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (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

importAPIProductCall

public okhttp3.Call importAPIProductCall(File file,
                                         Boolean preserveProvider,
                                         Boolean rotateRevision,
                                         Boolean importAPIs,
                                         Boolean overwriteAPIProduct,
                                         Boolean overwriteAPIs,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for importAPIProduct

Parameters:

file - Zip archive consisting on exported API Product configuration (required)

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

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (optional)

importAPIs - Whether to import the dependent APIs or not. (optional)

overwriteAPIProduct - Whether to update the API Product or not. This is used when updating already existing API Products. (optional)

overwriteAPIs - Whether to update the dependent APIs or not. This is used when updating already existing dependent APIs of an API Product. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importAPIProduct

public void importAPIProduct(File file,
                             Boolean preserveProvider,
                             Boolean rotateRevision,
                             Boolean importAPIs,
                             Boolean overwriteAPIProduct,
                             Boolean overwriteAPIs)
                      throws ApiException

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

Parameters:

file - Zip archive consisting on exported API Product configuration (required)

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

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (optional)

importAPIs - Whether to import the dependent APIs or not. (optional)

overwriteAPIProduct - Whether to update the API Product or not. This is used when updating already existing API Products. (optional)

overwriteAPIs - Whether to update the dependent APIs or not. This is used when updating already existing dependent APIs of an API Product. (optional)

Throws:

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

importAPIProductWithHttpInfo

public ApiResponse<Void> importAPIProductWithHttpInfo(File file,
                                                      Boolean preserveProvider,
                                                      Boolean rotateRevision,
                                                      Boolean importAPIs,
                                                      Boolean overwriteAPIProduct,
                                                      Boolean overwriteAPIs)
                                               throws ApiException

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

Parameters:

file - Zip archive consisting on exported API Product configuration (required)

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

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (optional)

importAPIs - Whether to import the dependent APIs or not. (optional)

overwriteAPIProduct - Whether to update the API Product or not. This is used when updating already existing API Products. (optional)

overwriteAPIs - Whether to update the dependent APIs or not. This is used when updating already existing dependent APIs of an API Product. (optional)

Returns:

ApiResponse<Void>

Throws:

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

importAPIProductAsync

public okhttp3.Call importAPIProductAsync(File file,
                                          Boolean preserveProvider,
                                          Boolean rotateRevision,
                                          Boolean importAPIs,
                                          Boolean overwriteAPIProduct,
                                          Boolean overwriteAPIs,
                                          ApiCallback<Void> _callback)
                                   throws ApiException

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

Parameters:

file - Zip archive consisting on exported API Product configuration (required)

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

rotateRevision - Once the revision max limit reached, undeploy and delete the earliest revision and create a new revision (optional)

importAPIs - Whether to import the dependent APIs or not. (optional)

overwriteAPIProduct - Whether to update the API Product or not. This is used when updating already existing API Products. (optional)

overwriteAPIs - Whether to update the dependent APIs or not. This is used when updating already existing dependent APIs of an API Product. (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