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

    • ThrottlingPoliciesApi

      public ThrottlingPoliciesApi()

    • ThrottlingPoliciesApi

      public ThrottlingPoliciesApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getAllThrottlingPoliciesCall

      public okhttp3.Call getAllThrottlingPoliciesCall(String policyLevel, Integer limit, Integer offset, String ifNoneMatch, ApiCallback _callback) 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)
      _callback - Callback for upload/download progress
      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 okhttp3.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

    • getSubscriptionThrottlingPoliciesCall

      public okhttp3.Call getSubscriptionThrottlingPoliciesCall(Integer limit, Integer offset, String ifNoneMatch, ApiCallback _callback) throws ApiException
      Build call for getSubscriptionThrottlingPolicies
      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)
      ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getSubscriptionThrottlingPolicies

      public SubscriptionPolicyListDTO getSubscriptionThrottlingPolicies(Integer limit, Integer offset, String ifNoneMatch) throws ApiException
      Get streaming throttling policies This operation can be used to list the available streaming subscription policies
      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)
      ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
      Returns:
      SubscriptionPolicyListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSubscriptionThrottlingPoliciesWithHttpInfo

      public ApiResponse<SubscriptionPolicyListDTO> getSubscriptionThrottlingPoliciesWithHttpInfo(Integer limit, Integer offset, String ifNoneMatch) throws ApiException
      Get streaming throttling policies This operation can be used to list the available streaming subscription policies
      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)
      ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)
      Returns:
      ApiResponse<SubscriptionPolicyListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getSubscriptionThrottlingPoliciesAsync

      public okhttp3.Call getSubscriptionThrottlingPoliciesAsync(Integer limit, Integer offset, String ifNoneMatch, ApiCallback<SubscriptionPolicyListDTO> _callback) throws ApiException
      Get streaming throttling policies (asynchronously) This operation can be used to list the available streaming subscription policies
      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)
      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 okhttp3.Call getThrottlingPolicyByNameCall(String policyName, String policyLevel, String ifNoneMatch, ApiCallback _callback) 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)
      _callback - Callback for upload/download progress
      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 okhttp3.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