Package org.wso2.am.integration.clients.gateway.api.v2

Class UndeployApiApi

java.lang.Object

org.wso2.am.integration.clients.gateway.api.v2.UndeployApiApi

public class UndeployApiApi
extends Object

Constructor Summary

Constructors

Constructor	Description
UndeployApiApi()
UndeployApiApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
DeployResponseDTO	undeployAPI(String apiName, String version, String tenantDomain)	Uneploy the API in the gateway This operation is used to undeploy an API in the gateway.
com.squareup.okhttp.Call	undeployAPIAsync(String apiName, String version, String tenantDomain, ApiCallback<DeployResponseDTO> callback)	Uneploy the API in the gateway (asynchronously) This operation is used to undeploy an API in the gateway.
com.squareup.okhttp.Call	undeployAPICall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for undeployAPI
ApiResponse<DeployResponseDTO>	undeployAPIWithHttpInfo(String apiName, String version, String tenantDomain)	Uneploy the API in the gateway This operation is used to undeploy an API in the gateway.

Methods inherited from class java.lang.Object

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

Constructor Detail

UndeployApiApi

public UndeployApiApi()

UndeployApiApi

public UndeployApiApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

undeployAPICall

public com.squareup.okhttp.Call undeployAPICall(String apiName,
                                                String version,
                                                String tenantDomain,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for undeployAPI

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

undeployAPI

public DeployResponseDTO undeployAPI(String apiName,
                                     String version,
                                     String tenantDomain)
                              throws ApiException

Uneploy the API in the gateway This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

DeployResponseDTO

Throws:

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

undeployAPIWithHttpInfo

public ApiResponse<DeployResponseDTO> undeployAPIWithHttpInfo(String apiName,
                                                              String version,
                                                              String tenantDomain)
                                                       throws ApiException

Uneploy the API in the gateway This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<DeployResponseDTO>

Throws:

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

undeployAPIAsync

public com.squareup.okhttp.Call undeployAPIAsync(String apiName,
                                                 String version,
                                                 String tenantDomain,
                                                 ApiCallback<DeployResponseDTO> callback)
                                          throws ApiException

Uneploy the API in the gateway (asynchronously) This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiName - Name of the API (required)

version - version of the API (required)

tenantDomain - Tenant Domain of the API (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