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

Class ThrottlingPoliciesApi

  • public class ThrottlingPoliciesApi
extends Object

    • Constructor Detail

      • ThrottlingPoliciesApi

        public ThrottlingPoliciesApi()

      • ThrottlingPoliciesApi

        public ThrottlingPoliciesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • throttlingPoliciesPolicyLevelGetCall

        public okhttp3.Call throttlingPoliciesPolicyLevelGetCall​(String policyLevel,
                                                         Integer limit,
                                                         Integer offset,
                                                         String ifNoneMatch,
                                                         String xWSO2Tenant,
                                                         ApiCallback _callback)
                                                  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 retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • throttlingPoliciesPolicyLevelGet

        public 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 retrieved from. (optional)
        Returns:
        ThrottlingPolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • throttlingPoliciesPolicyLevelGetWithHttpInfo

        public ApiResponse<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 retrieved from. (optional)
        Returns:
        ApiResponse<ThrottlingPolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • throttlingPoliciesPolicyLevelGetAsync

        public okhttp3.Call throttlingPoliciesPolicyLevelGetAsync​(String policyLevel,
                                                          Integer limit,
                                                          Integer offset,
                                                          String ifNoneMatch,
                                                          String xWSO2Tenant,
                                                          ApiCallback<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 retrieved 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 okhttp3.Call throttlingPoliciesPolicyLevelPolicyIdGetCall​(String policyId,
                                                                 String policyLevel,
                                                                 String xWSO2Tenant,
                                                                 String ifNoneMatch,
                                                                 ApiCallback _callback)
                                                          throws ApiException
        Build call for throttlingPoliciesPolicyLevelPolicyIdGet
        Parameters:
        policyId - The name of the policy (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 retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        _callback - Callback for upload/download progress
        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 - The name of the policy (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 retrieved 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 - The name of the policy (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 retrieved 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 okhttp3.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 - The name of the policy (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 retrieved 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