org.wso2.carbon.apimgt.rest.integration.tests.api

Class ThrottlingTierCollectionApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.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()
TierList	policiesTierLevelGet(String tierLevel, Integer limit, Integer offset, String accept, String ifNoneMatch) Get all policies This operation can be used to list the available policies for a given policy level.
com.squareup.okhttp.Call	policiesTierLevelGetAsync(String tierLevel, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<TierList> callback) Get all policies (asynchronously) This operation can be used to list the available policies for a given policy level.
ApiResponse<TierList>	policiesTierLevelGetWithHttpInfo(String tierLevel, Integer limit, Integer offset, String accept, String ifNoneMatch) Get all policies This operation can be used to list the available policies for a given policy level.
Tier	policiesTierLevelPost(Tier body, String tierLevel, String contentType) Create a Tier This operation can be used to create a new throttling policy.
com.squareup.okhttp.Call	policiesTierLevelPostAsync(Tier body, String tierLevel, String contentType, ApiCallback<Tier> callback) Create a Tier (asynchronously) This operation can be used to create a new throttling policy.
ApiResponse<Tier>	policiesTierLevelPostWithHttpInfo(Tier body, String tierLevel, String contentType) Create a Tier This operation can be used to create a new throttling policy.
void	setApiClient(ApiClient apiClient)

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)

policiesTierLevelGet

public TierList policiesTierLevelGet(String tierLevel,
                                     Integer limit,
                                     Integer offset,
                                     String accept,
                                     String ifNoneMatch)
                              throws ApiException

Get all policies This operation can be used to list the available policies for a given policy level. Tier level should be specified as a path parameter and should be one of `api`, `application` and `resource`.

Parameters:

tierLevel - List API or Application or Resource type policies. (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)

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

Returns:

TierList

Throws:

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

policiesTierLevelGetWithHttpInfo

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

Get all policies This operation can be used to list the available policies for a given policy level. Tier level should be specified as a path parameter and should be one of `api`, `application` and `resource`.

Parameters:

tierLevel - List API or Application or Resource type policies. (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)

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

Returns:

ApiResponse<TierList>

Throws:

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

policiesTierLevelGetAsync

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

Get all policies (asynchronously) This operation can be used to list the available policies for a given policy level. Tier level should be specified as a path parameter and should be one of `api`, `application` and `resource`.

Parameters:

tierLevel - List API or Application or Resource type policies. (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)

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 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

policiesTierLevelPost

public Tier policiesTierLevelPost(Tier body,
                                  String tierLevel,
                                  String contentType)
                           throws ApiException

Create a Tier This operation can be used to create a new throttling policy. The only supported policy level is `api` policies. `POST https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api` **IMPORTANT:** * This is only effective when Advanced Throttling is disabled in the Server. If enabled, we need to use Admin REST API for throttling policies modification related operations.

Parameters:

body - Tier object that should to be added (required)

tierLevel - List API or Application or Resource type policies. (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

Returns:

Tier

Throws:

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

policiesTierLevelPostWithHttpInfo

public ApiResponse<Tier> policiesTierLevelPostWithHttpInfo(Tier body,
                                                           String tierLevel,
                                                           String contentType)
                                                    throws ApiException

Create a Tier This operation can be used to create a new throttling policy. The only supported policy level is `api` policies. `POST https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api` **IMPORTANT:** * This is only effective when Advanced Throttling is disabled in the Server. If enabled, we need to use Admin REST API for throttling policies modification related operations.

Parameters:

body - Tier object that should to be added (required)

tierLevel - List API or Application or Resource type policies. (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

Returns:

ApiResponse<Tier>

Throws:

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

policiesTierLevelPostAsync

public com.squareup.okhttp.Call policiesTierLevelPostAsync(Tier body,
                                                           String tierLevel,
                                                           String contentType,
                                                           ApiCallback<Tier> callback)
                                                    throws ApiException

Create a Tier (asynchronously) This operation can be used to create a new throttling policy. The only supported policy level is `api` policies. `POST https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api` **IMPORTANT:** * This is only effective when Advanced Throttling is disabled in the Server. If enabled, we need to use Admin REST API for throttling policies modification related operations.

Parameters:

body - Tier object that should to be added (required)

tierLevel - List API or Application or Resource type policies. (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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