org.wso2.carbon.apimgt.samples.utils.store.rest.client.api

Class ThrottlingTierCollectionApi

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.store.rest.client.api.ThrottlingTierCollectionApi

public class ThrottlingTierCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ThrottlingTierCollectionApi()
ThrottlingTierCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
List<TierList>	tiersTierLevelGet(String tierLevel, Integer limit, Integer offset, String xWSO2Tenant, String accept, String ifNoneMatch) Get available tiers This operation can be used to retrieve all the tiers available for the provided tier level.
com.squareup.okhttp.Call	tiersTierLevelGetAsync(String tierLevel, Integer limit, Integer offset, String xWSO2Tenant, String accept, String ifNoneMatch, ApiCallback<List<TierList>> callback) Get available tiers (asynchronously) This operation can be used to retrieve all the tiers available for the provided tier level.
ApiResponse<List<TierList>>	tiersTierLevelGetWithHttpInfo(String tierLevel, Integer limit, Integer offset, String xWSO2Tenant, String accept, String ifNoneMatch) Get available tiers This operation can be used to retrieve all the tiers available for the provided tier level.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottlingTierCollectionApi

public ThrottlingTierCollectionApi()

ThrottlingTierCollectionApi

public ThrottlingTierCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

tiersTierLevelGet

public List<TierList> tiersTierLevelGet(String tierLevel,
                                        Integer limit,
                                        Integer offset,
                                        String xWSO2Tenant,
                                        String accept,
                                        String ifNoneMatch)
                                 throws ApiException

Get available tiers This operation can be used to retrieve all the tiers available for the provided tier level. Tier level should be specified as a path parameter and should be one of `api` and `application`. `X-WSO2-Tenant` header can be used to retrive tiers 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**: * API tiers are the ones that is available during subscription of an application to an API. Hence they are also called subscription tiers and are same as the subscription policies in Admin REST API.

Parameters:

tierLevel - List API or Application type tiers. (required)

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 retirieved from. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

Returns:

List<TierList>

Throws:

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

tiersTierLevelGetWithHttpInfo

public ApiResponse<List<TierList>> tiersTierLevelGetWithHttpInfo(String tierLevel,
                                                                 Integer limit,
                                                                 Integer offset,
                                                                 String xWSO2Tenant,
                                                                 String accept,
                                                                 String ifNoneMatch)
                                                          throws ApiException

Get available tiers This operation can be used to retrieve all the tiers available for the provided tier level. Tier level should be specified as a path parameter and should be one of `api` and `application`. `X-WSO2-Tenant` header can be used to retrive tiers 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**: * API tiers are the ones that is available during subscription of an application to an API. Hence they are also called subscription tiers and are same as the subscription policies in Admin REST API.

Parameters:

tierLevel - List API or Application type tiers. (required)

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 retirieved from. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

Returns:

ApiResponse<List<TierList>>

Throws:

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

tiersTierLevelGetAsync

public com.squareup.okhttp.Call tiersTierLevelGetAsync(String tierLevel,
                                                       Integer limit,
                                                       Integer offset,
                                                       String xWSO2Tenant,
                                                       String accept,
                                                       String ifNoneMatch,
                                                       ApiCallback<List<TierList>> callback)
                                                throws ApiException

Get available tiers (asynchronously) This operation can be used to retrieve all the tiers available for the provided tier level. Tier level should be specified as a path parameter and should be one of `api` and `application`. `X-WSO2-Tenant` header can be used to retrive tiers 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**: * API tiers are the ones that is available during subscription of an application to an API. Hence they are also called subscription tiers and are same as the subscription policies in Admin REST API.

Parameters:

tierLevel - List API or Application type tiers. (required)

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 retirieved from. (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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