org.wso2.am.integration.clients.store.api.v1

Class ApIsApi

java.lang.Object

org.wso2.am.integration.clients.store.api.v1.ApIsApi

public class ApIsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApIsApi()
ApIsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIDTO	apisApiIdGet(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Details of an API Using this operation, you can retrieve complete details of a single API.
okhttp3.Call	apisApiIdGetAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<APIDTO> _callback) Get Details of an API (asynchronously) Using this operation, you can retrieve complete details of a single API.
okhttp3.Call	apisApiIdGetCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback) Build call for apisApiIdGet
ApiResponse<APIDTO>	apisApiIdGetWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Details of an API Using this operation, you can retrieve complete details of a single API.
void	apisApiIdGraphqlSchemaGet(String apiId, String ifNoneMatch, String xWSO2Tenant) Get GraphQL Definition You can use this operation to retrieve the swagger definition of an API.
okhttp3.Call	apisApiIdGraphqlSchemaGetAsync(String apiId, String ifNoneMatch, String xWSO2Tenant, ApiCallback<Void> _callback) Get GraphQL Definition (asynchronously) You can use this operation to retrieve the swagger definition of an API.
okhttp3.Call	apisApiIdGraphqlSchemaGetCall(String apiId, String ifNoneMatch, String xWSO2Tenant, ApiCallback _callback) Build call for apisApiIdGraphqlSchemaGet
ApiResponse<Void>	apisApiIdGraphqlSchemaGetWithHttpInfo(String apiId, String ifNoneMatch, String xWSO2Tenant) Get GraphQL Definition You can use this operation to retrieve the swagger definition of an API.
ThrottlingPolicyDTO	apisApiIdSubscriptionPoliciesGet(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.
okhttp3.Call	apisApiIdSubscriptionPoliciesGetAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<ThrottlingPolicyDTO> _callback) Get Details of the Subscription Throttling Policies of an API (asynchronously) This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.
okhttp3.Call	apisApiIdSubscriptionPoliciesGetCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback) Build call for apisApiIdSubscriptionPoliciesGet
ApiResponse<ThrottlingPolicyDTO>	apisApiIdSubscriptionPoliciesGetWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id.
String	apisApiIdSwaggerGet(String apiId, String labelName, String environmentName, String clusterName, String ifNoneMatch, String xWSO2Tenant) Get Swagger Definition You can use this operation to retrieve the swagger definition of an API.
okhttp3.Call	apisApiIdSwaggerGetAsync(String apiId, String labelName, String environmentName, String clusterName, String ifNoneMatch, String xWSO2Tenant, ApiCallback<String> _callback) Get Swagger Definition (asynchronously) You can use this operation to retrieve the swagger definition of an API.
okhttp3.Call	apisApiIdSwaggerGetCall(String apiId, String labelName, String environmentName, String clusterName, String ifNoneMatch, String xWSO2Tenant, ApiCallback _callback) Build call for apisApiIdSwaggerGet
ApiResponse<String>	apisApiIdSwaggerGetWithHttpInfo(String apiId, String labelName, String environmentName, String clusterName, String ifNoneMatch, String xWSO2Tenant) Get Swagger Definition You can use this operation to retrieve the swagger definition of an API.
void	apisApiIdThumbnailGet(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Thumbnail Image This operation can be used to download a thumbnail image of an API.
okhttp3.Call	apisApiIdThumbnailGetAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<Void> _callback) Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API.
okhttp3.Call	apisApiIdThumbnailGetCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback _callback) Build call for apisApiIdThumbnailGet
ApiResponse<Void>	apisApiIdThumbnailGetWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) Get Thumbnail Image This operation can be used to download a thumbnail image of an API.
APIListDTO	apisGet(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
okhttp3.Call	apisGetAsync(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch, ApiCallback<APIListDTO> _callback) Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition.
okhttp3.Call	apisGetCall(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch, ApiCallback _callback) Build call for apisGet
ApiResponse<APIListDTO>	apisGetWithHttpInfo(Integer limit, Integer offset, String xWSO2Tenant, String query, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
ApiClient	getApiClient()
void	getWSDLOfAPI(String apiId, String labelName, String environmentName, String ifNoneMatch, String xWSO2Tenant) Get API WSDL definition This operation can be used to retrieve the swagger definition of an API.
okhttp3.Call	getWSDLOfAPIAsync(String apiId, String labelName, String environmentName, String ifNoneMatch, String xWSO2Tenant, ApiCallback<Void> _callback) Get API WSDL definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.
okhttp3.Call	getWSDLOfAPICall(String apiId, String labelName, String environmentName, String ifNoneMatch, String xWSO2Tenant, ApiCallback _callback) Build call for getWSDLOfAPI
ApiResponse<Void>	getWSDLOfAPIWithHttpInfo(String apiId, String labelName, String environmentName, String ifNoneMatch, String xWSO2Tenant) Get API WSDL definition This operation can be used to retrieve the swagger definition of 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

ApIsApi

public ApIsApi()

ApIsApi

public ApIsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdGetCall

public okhttp3.Call apisApiIdGetCall(String apiId,
                                     String xWSO2Tenant,
                                     String ifNoneMatch,
                                     ApiCallback _callback)
                              throws ApiException

Build call for apisApiIdGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdGet

public APIDTO apisApiIdGet(String apiId,
                           String xWSO2Tenant,
                           String ifNoneMatch)
                    throws ApiException

Get Details of an API Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it. `X-WSO2-Tenant` header can be used to retrieve an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

APIDTO

Throws:

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

apisApiIdGetWithHttpInfo

public ApiResponse<APIDTO> apisApiIdGetWithHttpInfo(String apiId,
                                                    String xWSO2Tenant,
                                                    String ifNoneMatch)
                                             throws ApiException

Get Details of an API Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it. `X-WSO2-Tenant` header can be used to retrieve an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<APIDTO>

Throws:

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

apisApiIdGetAsync

public okhttp3.Call apisApiIdGetAsync(String apiId,
                                      String xWSO2Tenant,
                                      String ifNoneMatch,
                                      ApiCallback<APIDTO> _callback)
                               throws ApiException

Get Details of an API (asynchronously) Using this operation, you can retrieve complete details of a single API. You need to provide the Id of the API to retrive it. `X-WSO2-Tenant` header can be used to retrieve an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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

apisApiIdGraphqlSchemaGetCall

public okhttp3.Call apisApiIdGraphqlSchemaGetCall(String apiId,
                                                  String ifNoneMatch,
                                                  String xWSO2Tenant,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for apisApiIdGraphqlSchemaGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdGraphqlSchemaGet

public void apisApiIdGraphqlSchemaGet(String apiId,
                                      String ifNoneMatch,
                                      String xWSO2Tenant)
                               throws ApiException

Get GraphQL Definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Throws:

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

apisApiIdGraphqlSchemaGetWithHttpInfo

public ApiResponse<Void> apisApiIdGraphqlSchemaGetWithHttpInfo(String apiId,
                                                               String ifNoneMatch,
                                                               String xWSO2Tenant)
                                                        throws ApiException

Get GraphQL Definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdGraphqlSchemaGetAsync

public okhttp3.Call apisApiIdGraphqlSchemaGetAsync(String apiId,
                                                   String ifNoneMatch,
                                                   String xWSO2Tenant,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException

Get GraphQL Definition (asynchronously) You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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

apisApiIdSubscriptionPoliciesGetCall

public okhttp3.Call apisApiIdSubscriptionPoliciesGetCall(String apiId,
                                                         String xWSO2Tenant,
                                                         String ifNoneMatch,
                                                         ApiCallback _callback)
                                                  throws ApiException

Build call for apisApiIdSubscriptionPoliciesGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdSubscriptionPoliciesGet

public ThrottlingPolicyDTO apisApiIdSubscriptionPoliciesGet(String apiId,
                                                            String xWSO2Tenant,
                                                            String ifNoneMatch)
                                                     throws ApiException

Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ThrottlingPolicyDTO

Throws:

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

apisApiIdSubscriptionPoliciesGetWithHttpInfo

public ApiResponse<ThrottlingPolicyDTO> apisApiIdSubscriptionPoliciesGetWithHttpInfo(String apiId,
                                                                                     String xWSO2Tenant,
                                                                                     String ifNoneMatch)
                                                                              throws ApiException

Get Details of the Subscription Throttling Policies of an API This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<ThrottlingPolicyDTO>

Throws:

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

apisApiIdSubscriptionPoliciesGetAsync

public okhttp3.Call apisApiIdSubscriptionPoliciesGetAsync(String apiId,
                                                          String xWSO2Tenant,
                                                          String ifNoneMatch,
                                                          ApiCallback<ThrottlingPolicyDTO> _callback)
                                                   throws ApiException

Get Details of the Subscription Throttling Policies of an API (asynchronously) This operation can be used to retrieve details of the subscription throttling policy of an API by specifying the API Id. `X-WSO2-Tenant` header can be used to retrive API subscription throttling policies that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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

apisApiIdSwaggerGetCall

public okhttp3.Call apisApiIdSwaggerGetCall(String apiId,
                                            String labelName,
                                            String environmentName,
                                            String clusterName,
                                            String ifNoneMatch,
                                            String xWSO2Tenant,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for apisApiIdSwaggerGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

clusterName - Name of the container managed cluster name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdSwaggerGet

public String apisApiIdSwaggerGet(String apiId,
                                  String labelName,
                                  String environmentName,
                                  String clusterName,
                                  String ifNoneMatch,
                                  String xWSO2Tenant)
                           throws ApiException

Get Swagger Definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

clusterName - Name of the container managed cluster name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

String

Throws:

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

apisApiIdSwaggerGetWithHttpInfo

public ApiResponse<String> apisApiIdSwaggerGetWithHttpInfo(String apiId,
                                                           String labelName,
                                                           String environmentName,
                                                           String clusterName,
                                                           String ifNoneMatch,
                                                           String xWSO2Tenant)
                                                    throws ApiException

Get Swagger Definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

clusterName - Name of the container managed cluster name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

ApiResponse<String>

Throws:

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

apisApiIdSwaggerGetAsync

public okhttp3.Call apisApiIdSwaggerGetAsync(String apiId,
                                             String labelName,
                                             String environmentName,
                                             String clusterName,
                                             String ifNoneMatch,
                                             String xWSO2Tenant,
                                             ApiCallback<String> _callback)
                                      throws ApiException

Get Swagger Definition (asynchronously) You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrieve the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

clusterName - Name of the container managed cluster name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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

apisApiIdThumbnailGetCall

public okhttp3.Call apisApiIdThumbnailGetCall(String apiId,
                                              String xWSO2Tenant,
                                              String ifNoneMatch,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for apisApiIdThumbnailGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdThumbnailGet

public void apisApiIdThumbnailGet(String apiId,
                                  String xWSO2Tenant,
                                  String ifNoneMatch)
                           throws ApiException

Get Thumbnail Image This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Throws:

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

apisApiIdThumbnailGetWithHttpInfo

public ApiResponse<Void> apisApiIdThumbnailGetWithHttpInfo(String apiId,
                                                           String xWSO2Tenant,
                                                           String ifNoneMatch)
                                                    throws ApiException

Get Thumbnail Image This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdThumbnailGetAsync

public okhttp3.Call apisApiIdThumbnailGetAsync(String apiId,
                                               String xWSO2Tenant,
                                               String ifNoneMatch,
                                               ApiCallback<Void> _callback)
                                        throws ApiException

Get Thumbnail Image (asynchronously) This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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 okhttp3.Call apisGetCall(Integer limit,
                                Integer offset,
                                String xWSO2Tenant,
                                String query,
                                String ifNoneMatch,
                                ApiCallback _callback)
                         throws ApiException

Build call for apisGet

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisGet

public APIListDTO apisGet(Integer limit,
                          Integer offset,
                          String xWSO2Tenant,
                          String query,
                          String ifNoneMatch)
                   throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retrieving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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(Integer limit,
                                                   Integer offset,
                                                   String xWSO2Tenant,
                                                   String query,
                                                   String ifNoneMatch)
                                            throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retrieving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<APIListDTO>

Throws:

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

apisGetAsync

public okhttp3.Call apisGetAsync(Integer limit,
                                 Integer offset,
                                 String xWSO2Tenant,
                                 String query,
                                 String ifNoneMatch,
                                 ApiCallback<APIListDTO> _callback)
                          throws ApiException

Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation. This operation supports retrieving APIs of other tenants. The required tenant domain need to be specified as a header `X-WSO2-Tenant`. If not specified super tenant's APIs will be retrieved. If you used an Authorization header, the user's tenant associated with the access token will be used. **NOTE:** * By default, this operation retrieves Published APIs. In order to retrieve Prototyped APIs, you need to use **query** parameter and specify **status:PROTOTYPED**. * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, status, description, subcontext, doc, provider, tag**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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

getWSDLOfAPICall

public okhttp3.Call getWSDLOfAPICall(String apiId,
                                     String labelName,
                                     String environmentName,
                                     String ifNoneMatch,
                                     String xWSO2Tenant,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getWSDLOfAPI

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getWSDLOfAPI

public void getWSDLOfAPI(String apiId,
                         String labelName,
                         String environmentName,
                         String ifNoneMatch,
                         String xWSO2Tenant)
                  throws ApiException

Get API WSDL definition This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Throws:

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

getWSDLOfAPIWithHttpInfo

public ApiResponse<Void> getWSDLOfAPIWithHttpInfo(String apiId,
                                                  String labelName,
                                                  String environmentName,
                                                  String ifNoneMatch,
                                                  String xWSO2Tenant)
                                           throws ApiException

Get API WSDL definition This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)

Returns:

ApiResponse<Void>

Throws:

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

getWSDLOfAPIAsync

public okhttp3.Call getWSDLOfAPIAsync(String apiId,
                                      String labelName,
                                      String environmentName,
                                      String ifNoneMatch,
                                      String xWSO2Tenant,
                                      ApiCallback<Void> _callback)
                               throws ApiException

Get API WSDL definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

labelName - Name of the API microgateway labels (optional)

environmentName - Name of the API gateway environment. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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