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

Class GetApiInfoApi

java.lang.Object

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

public class GetApiInfoApi
extends Object

Constructor Summary

Constructors

Constructor	Description
GetApiInfoApi()
GetApiInfoApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
APIInfoDTO	apisApiIdGet(String apiId, String tenantDomain)	Get the subscription information of an api by providing the api uuid.
com.squareup.okhttp.Call	apisApiIdGetAsync(String apiId, String tenantDomain, ApiCallback<APIInfoDTO> callback)	Get the subscription information of an api by providing the api uuid.
com.squareup.okhttp.Call	apisApiIdGetCall(String apiId, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for apisApiIdGet
ApiResponse<APIInfoDTO>	apisApiIdGetWithHttpInfo(String apiId, String tenantDomain)	Get the subscription information of an api by providing the api uuid.
APIListDTO	apisGet(String context, String version, String tenantDomain)	Get the list of APIS by providing context and version.
com.squareup.okhttp.Call	apisGetAsync(String context, String version, String tenantDomain, ApiCallback<APIListDTO> callback)	Get the list of APIS by providing context and version.
com.squareup.okhttp.Call	apisGetCall(String context, String version, String tenantDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for apisGet
ApiResponse<APIListDTO>	apisGetWithHttpInfo(String context, String version, String tenantDomain)	Get the list of APIS by providing context and version.
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

GetApiInfoApi

public GetApiInfoApi()

GetApiInfoApi

public GetApiInfoApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdGetCall

public com.squareup.okhttp.Call apisApiIdGetCall(String apiId,
                                                 String tenantDomain,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for apisApiIdGet

Parameters:

apiId - API ID 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

apisApiIdGet

public APIInfoDTO apisApiIdGet(String apiId,
                               String tenantDomain)
                        throws ApiException

Get the subscription information of an api by providing the api uuid. This operation is used to get the subscription information of an API from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiId - API ID of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

APIInfoDTO

Throws:

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

apisApiIdGetWithHttpInfo

public ApiResponse<APIInfoDTO> apisApiIdGetWithHttpInfo(String apiId,
                                                        String tenantDomain)
                                                 throws ApiException

Get the subscription information of an api by providing the api uuid. This operation is used to get the subscription information of an API from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiId - API ID of the API (required)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<APIInfoDTO>

Throws:

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

apisApiIdGetAsync

public com.squareup.okhttp.Call apisApiIdGetAsync(String apiId,
                                                  String tenantDomain,
                                                  ApiCallback<APIInfoDTO> callback)
                                           throws ApiException

Get the subscription information of an api by providing the api uuid. (asynchronously) This operation is used to get the subscription information of an API from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

apiId - API ID 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

apisGetCall

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

Build call for apisGet

Parameters:

context - Context of the API (optional)

version - version of the API (optional)

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

apisGet

public APIListDTO apisGet(String context,
                          String version,
                          String tenantDomain)
                   throws ApiException

Get the list of APIS by providing context and version. This operation is used to get the API information from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

context - Context of the API (optional)

version - version of the API (optional)

tenantDomain - Tenant Domain of the API (optional)

Returns:

APIListDTO

Throws:

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

apisGetWithHttpInfo

public ApiResponse<APIListDTO> apisGetWithHttpInfo(String context,
                                                   String version,
                                                   String tenantDomain)
                                            throws ApiException

Get the list of APIS by providing context and version. This operation is used to get the API information from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

context - Context of the API (optional)

version - version of the API (optional)

tenantDomain - Tenant Domain of the API (optional)

Returns:

ApiResponse<APIListDTO>

Throws:

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

apisGetAsync

public com.squareup.okhttp.Call apisGetAsync(String context,
                                             String version,
                                             String tenantDomain,
                                             ApiCallback<APIListDTO> callback)
                                      throws ApiException

Get the list of APIS by providing context and version. (asynchronously) This operation is used to get the API information from storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.

Parameters:

context - Context of the API (optional)

version - version of the API (optional)

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