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

Class DeployApiApi

java.lang.Object

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

public class DeployApiApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DeployApiApi()
DeployApiApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
DeployResponseDTO	redployAPI(String apiName, String version, String tenantDomain)	Re Deploy the API in the gateway This operation is used to re deploy an API in the gateway.
com.squareup.okhttp.Call	redployAPIAsync(String apiName, String version, String tenantDomain, ApiCallback<DeployResponseDTO> callback)	Re Deploy the API in the gateway (asynchronously) This operation is used to re deploy an API in the gateway.
com.squareup.okhttp.Call	redployAPICall(String apiName, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for redployAPI
ApiResponse<DeployResponseDTO>	redployAPIWithHttpInfo(String apiName, String version, String tenantDomain)	Re Deploy the API in the gateway This operation is used to re deploy an API in the gateway.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeployApiApi

public DeployApiApi()

DeployApiApi

public DeployApiApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

redployAPICall

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

Build call for redployAPI

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

redployAPI

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

Re Deploy the API in the gateway This operation is used to re deploy 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

redployAPIWithHttpInfo

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

Re Deploy the API in the gateway This operation is used to re deploy 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

redployAPIAsync

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

Re Deploy the API in the gateway (asynchronously) This operation is used to re deploy 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