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

Class ThrottlingPoliciesApi

java.lang.Object

org.wso2.am.integration.clients.store.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
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
List<ThrottlingPolicyListDTO>	throttlingPoliciesPolicyLevelGet(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, String xWSO2Tenant) Get all available throttling policies Get available Throttling Policies
com.squareup.okhttp.Call	throttlingPoliciesPolicyLevelGetAsync(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, String xWSO2Tenant, ApiCallback<List<ThrottlingPolicyListDTO>> callback) Get all available throttling policies (asynchronously) Get available Throttling Policies
com.squareup.okhttp.Call	throttlingPoliciesPolicyLevelGetCall(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesPolicyLevelGet
ApiResponse<List<ThrottlingPolicyListDTO>>	throttlingPoliciesPolicyLevelGetWithHttpInfo(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, String xWSO2Tenant) Get all available throttling policies Get available Throttling Policies
ThrottlingPolicyDTO	throttlingPoliciesPolicyLevelPolicyIdGet(String policyId, String policyLevel, String xWSO2Tenant, String ifNoneMatch) Get details of a throttling policy This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name.
com.squareup.okhttp.Call	throttlingPoliciesPolicyLevelPolicyIdGetAsync(String policyId, String policyLevel, String xWSO2Tenant, String ifNoneMatch, ApiCallback<ThrottlingPolicyDTO> callback) Get details of a throttling policy (asynchronously) This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name.
com.squareup.okhttp.Call	throttlingPoliciesPolicyLevelPolicyIdGetCall(String policyId, String policyLevel, String xWSO2Tenant, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesPolicyLevelPolicyIdGet
ApiResponse<ThrottlingPolicyDTO>	throttlingPoliciesPolicyLevelPolicyIdGetWithHttpInfo(String policyId, String policyLevel, String xWSO2Tenant, String ifNoneMatch) Get details of a throttling policy This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name.

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)

throttlingPoliciesPolicyLevelGetCall

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

Build call for throttlingPoliciesPolicyLevelGet

Parameters:

policyLevel - List Application or Subscription type thro. (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 resourec. (optional)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesPolicyLevelGet

public List<ThrottlingPolicyListDTO> throttlingPoliciesPolicyLevelGet(String policyLevel,
                                                                      Integer limit,
                                                                      Integer offset,
                                                                      String ifNoneMatch,
                                                                      String xWSO2Tenant)
                                                               throws ApiException

Get all available throttling policies Get available Throttling Policies

Parameters:

policyLevel - List Application or Subscription type thro. (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 resourec. (optional)

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

Returns:

List<ThrottlingPolicyListDTO>

Throws:

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

throttlingPoliciesPolicyLevelGetWithHttpInfo

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

Get all available throttling policies Get available Throttling Policies

Parameters:

policyLevel - List Application or Subscription type thro. (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 resourec. (optional)

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

Returns:

ApiResponse<List<ThrottlingPolicyListDTO>>

Throws:

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

throttlingPoliciesPolicyLevelGetAsync

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

Get all available throttling policies (asynchronously) Get available Throttling Policies

Parameters:

policyLevel - List Application or Subscription type thro. (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 resourec. (optional)

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

throttlingPoliciesPolicyLevelPolicyIdGetCall

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

Build call for throttlingPoliciesPolicyLevelPolicyIdGet

Parameters:

policyId - Policy Id represented as a UUID (required)

policyLevel - List Application or Subscription type thro. (required)

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesPolicyLevelPolicyIdGet

public ThrottlingPolicyDTO throttlingPoliciesPolicyLevelPolicyIdGet(String policyId,
                                                                    String policyLevel,
                                                                    String xWSO2Tenant,
                                                                    String ifNoneMatch)
                                                             throws ApiException

Get details of a throttling policy This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name. `X-WSO2-Tenant` header can be used to retrive throttling policy 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:

policyId - Policy Id represented as a UUID (required)

policyLevel - List Application or Subscription type thro. (required)

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

throttlingPoliciesPolicyLevelPolicyIdGetWithHttpInfo

public ApiResponse<ThrottlingPolicyDTO> throttlingPoliciesPolicyLevelPolicyIdGetWithHttpInfo(String policyId,
                                                                                             String policyLevel,
                                                                                             String xWSO2Tenant,
                                                                                             String ifNoneMatch)
                                                                                      throws ApiException

Get details of a throttling policy This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name. `X-WSO2-Tenant` header can be used to retrive throttling policy 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:

policyId - Policy Id represented as a UUID (required)

policyLevel - List Application or Subscription type thro. (required)

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

throttlingPoliciesPolicyLevelPolicyIdGetAsync

public com.squareup.okhttp.Call throttlingPoliciesPolicyLevelPolicyIdGetAsync(String policyId,
                                                                              String policyLevel,
                                                                              String xWSO2Tenant,
                                                                              String ifNoneMatch,
                                                                              ApiCallback<ThrottlingPolicyDTO> callback)
                                                                       throws ApiException

Get details of a throttling policy (asynchronously) This operation can be used to retrieve details of a single throttling policy by specifying the policy level and policy name. `X-WSO2-Tenant` header can be used to retrive throttling policy 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:

policyId - Policy Id represented as a UUID (required)

policyLevel - List Application or Subscription type thro. (required)

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