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

Class ApiProductIndividualApi

java.lang.Object

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

public class ApiProductIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiProductIndividualApi()
ApiProductIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
File	exportApiProductGet(String name, String version, String providerName, String format, Boolean preserveStatus) Export an API Product This operation can be used to export the details of a particular API Product as a zip file.
com.squareup.okhttp.Call	exportApiProductGetAsync(String name, String version, String providerName, String format, Boolean preserveStatus, 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.
com.squareup.okhttp.Call	exportApiProductGetCall(String name, String version, String providerName, String format, Boolean preserveStatus, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for exportApiProductGet
ApiResponse<File>	exportApiProductGetWithHttpInfo(String name, String version, String providerName, String format, Boolean preserveStatus) Export an API Product This operation can be used to export the details of a particular API Product as a zip file.
ApiClient	getApiClient()
void	importApiProductPost(File file, Boolean preserveProvider, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs) Import an API Product This operation can be used to import an API Product.
com.squareup.okhttp.Call	importApiProductPostAsync(File file, Boolean preserveProvider, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs, ApiCallback<Void> callback) Import an API Product (asynchronously) This operation can be used to import an API Product.
com.squareup.okhttp.Call	importApiProductPostCall(File file, Boolean preserveProvider, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for importApiProductPost
ApiResponse<Void>	importApiProductPostWithHttpInfo(File file, Boolean preserveProvider, Boolean importAPIs, Boolean overwriteAPIProduct, Boolean overwriteAPIs) Import an API Product This operation can be used to import an API Product.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiProductIndividualApi

public ApiProductIndividualApi()

ApiProductIndividualApi

public ApiProductIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

exportApiProductGetCall

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

Build call for exportApiProductGet

Parameters:

name - API Product Name (required)

version - Version of the API Product (required)

providerName - Provider name of the API Product (optional)

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

preserveStatus - Preserve API Product 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

exportApiProductGet

public File exportApiProductGet(String name,
                                String version,
                                String providerName,
                                String format,
                                Boolean preserveStatus)
                         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 (required)

version - Version of the API Product (required)

providerName - Provider name of the API Product (optional)

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

preserveStatus - Preserve API Product Status on export (optional)

Returns:

File

Throws:

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

exportApiProductGetWithHttpInfo

public ApiResponse<File> exportApiProductGetWithHttpInfo(String name,
                                                         String version,
                                                         String providerName,
                                                         String format,
                                                         Boolean preserveStatus)
                                                  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 (required)

version - Version of the API Product (required)

providerName - Provider name of the API Product (optional)

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

preserveStatus - Preserve API Product 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

exportApiProductGetAsync

public com.squareup.okhttp.Call exportApiProductGetAsync(String name,
                                                         String version,
                                                         String providerName,
                                                         String format,
                                                         Boolean preserveStatus,
                                                         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 (required)

version - Version of the API Product (required)

providerName - Provider name of the API Product (optional)

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

preserveStatus - Preserve API Product 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

importApiProductPostCall

public com.squareup.okhttp.Call importApiProductPostCall(File file,
                                                         Boolean preserveProvider,
                                                         Boolean importAPIs,
                                                         Boolean overwriteAPIProduct,
                                                         Boolean overwriteAPIs,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for importApiProductPost

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)

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importApiProductPost

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

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

importApiProductPostWithHttpInfo

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

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

importApiProductPostAsync

public com.squareup.okhttp.Call importApiProductPostAsync(File file,
                                                          Boolean preserveProvider,
                                                          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)

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