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

Class ThrottlingPoliciesApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.ThrottlingPoliciesApi

public class ThrottlingPoliciesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ThrottlingPoliciesApi()
ThrottlingPoliciesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ThrottlingPolicyListDTO	getAllThrottlingPolicies(String policyLevel, Integer limit, Integer offset, String ifNoneMatch) Get all throttling policies for the given type This operation can be used to list the available policies for a given policy level.
com.squareup.okhttp.Call	getAllThrottlingPoliciesAsync(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, ApiCallback<ThrottlingPolicyListDTO> callback) Get all throttling policies for the given type (asynchronously) This operation can be used to list the available policies for a given policy level.
com.squareup.okhttp.Call	getAllThrottlingPoliciesCall(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllThrottlingPolicies
ApiResponse<ThrottlingPolicyListDTO>	getAllThrottlingPoliciesWithHttpInfo(String policyLevel, Integer limit, Integer offset, String ifNoneMatch) Get all throttling policies for the given type This operation can be used to list the available policies for a given policy level.
ApiClient	getApiClient()
ThrottlingPolicyDTO	getThrottlingPolicyByName(String policyName, String policyLevel, String ifNoneMatch) Get details of a policy This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.
com.squareup.okhttp.Call	getThrottlingPolicyByNameAsync(String policyName, String policyLevel, String ifNoneMatch, ApiCallback<ThrottlingPolicyDTO> callback) Get details of a policy (asynchronously) This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.
com.squareup.okhttp.Call	getThrottlingPolicyByNameCall(String policyName, String policyLevel, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getThrottlingPolicyByName
ApiResponse<ThrottlingPolicyDTO>	getThrottlingPolicyByNameWithHttpInfo(String policyName, String policyLevel, String ifNoneMatch) Get details of a policy This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottlingPoliciesApi

public ThrottlingPoliciesApi()

ThrottlingPoliciesApi

public ThrottlingPoliciesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAllThrottlingPoliciesCall

public com.squareup.okhttp.Call getAllThrottlingPoliciesCall(String policyLevel,
                                                             Integer limit,
                                                             Integer offset,
                                                             String ifNoneMatch,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for getAllThrottlingPolicies

Parameters:

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllThrottlingPolicies

public ThrottlingPolicyListDTO getAllThrottlingPolicies(String policyLevel,
                                                        Integer limit,
                                                        Integer offset,
                                                        String ifNoneMatch)
                                                 throws ApiException

Get all throttling policies for the given type 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 `subscription` and `api`. `subscription` is for Subscription Level policies and `api` is for Resource Level policies

Parameters:

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

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

Returns:

ThrottlingPolicyListDTO

Throws:

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

getAllThrottlingPoliciesWithHttpInfo

public ApiResponse<ThrottlingPolicyListDTO> getAllThrottlingPoliciesWithHttpInfo(String policyLevel,
                                                                                 Integer limit,
                                                                                 Integer offset,
                                                                                 String ifNoneMatch)
                                                                          throws ApiException

Get all throttling policies for the given type 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 `subscription` and `api`. `subscription` is for Subscription Level policies and `api` is for Resource Level policies

Parameters:

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

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

Returns:

ApiResponse<ThrottlingPolicyListDTO>

Throws:

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

getAllThrottlingPoliciesAsync

public com.squareup.okhttp.Call getAllThrottlingPoliciesAsync(String policyLevel,
                                                              Integer limit,
                                                              Integer offset,
                                                              String ifNoneMatch,
                                                              ApiCallback<ThrottlingPolicyListDTO> callback)
                                                       throws ApiException

Get all throttling policies for the given type (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 `subscription` and `api`. `subscription` is for Subscription Level policies and `api` is for Resource Level policies

Parameters:

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

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

getThrottlingPolicyByNameCall

public com.squareup.okhttp.Call getThrottlingPolicyByNameCall(String policyName,
                                                              String policyLevel,
                                                              String ifNoneMatch,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for getThrottlingPolicyByName

Parameters:

policyName - Tier name (required)

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getThrottlingPolicyByName

public ThrottlingPolicyDTO getThrottlingPolicyByName(String policyName,
                                                     String policyLevel,
                                                     String ifNoneMatch)
                                              throws ApiException

Get details of a policy This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.

Parameters:

policyName - Tier name (required)

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

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

Returns:

ThrottlingPolicyDTO

Throws:

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

getThrottlingPolicyByNameWithHttpInfo

public ApiResponse<ThrottlingPolicyDTO> getThrottlingPolicyByNameWithHttpInfo(String policyName,
                                                                              String policyLevel,
                                                                              String ifNoneMatch)
                                                                       throws ApiException

Get details of a policy This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.

Parameters:

policyName - Tier name (required)

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

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

Returns:

ApiResponse<ThrottlingPolicyDTO>

Throws:

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

getThrottlingPolicyByNameAsync

public com.squareup.okhttp.Call getThrottlingPolicyByNameAsync(String policyName,
                                                               String policyLevel,
                                                               String ifNoneMatch,
                                                               ApiCallback<ThrottlingPolicyDTO> callback)
                                                        throws ApiException

Get details of a policy (asynchronously) This operation can be used to retrieve details of a single policy by specifying the policy level and policy name.

Parameters:

policyName - Tier name (required)

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

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