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

Class ThrottlingTierIndividualApi

java.lang.Object

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

public class ThrottlingTierIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ThrottlingTierIndividualApi()
ThrottlingTierIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	policiesTierLevelTierNameDelete(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince) Delete a Tier This operation can be used to delete an existing policy.
com.squareup.okhttp.Call	policiesTierLevelTierNameDeleteAsync(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Delete a Tier (asynchronously) This operation can be used to delete an existing policy.
ApiResponse<Void>	policiesTierLevelTierNameDeleteWithHttpInfo(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince) Delete a Tier This operation can be used to delete an existing policy.
Tier	policiesTierLevelTierNameGet(String tierName, String tierLevel, String accept, String ifNoneMatch, String ifModifiedSince) 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	policiesTierLevelTierNameGetAsync(String tierName, String tierLevel, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Tier> 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.
ApiResponse<Tier>	policiesTierLevelTierNameGetWithHttpInfo(String tierName, String tierLevel, String accept, String ifNoneMatch, String ifModifiedSince) 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.
Tier	policiesTierLevelTierNamePut(String tierName, Tier body, String tierLevel, String contentType, String ifMatch, String ifUnmodifiedSince) Update a Tier This operation can be used to update an existing policy.
com.squareup.okhttp.Call	policiesTierLevelTierNamePutAsync(String tierName, Tier body, String tierLevel, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<Tier> callback) Update a Tier (asynchronously) This operation can be used to update an existing policy.
ApiResponse<Tier>	policiesTierLevelTierNamePutWithHttpInfo(String tierName, Tier body, String tierLevel, String contentType, String ifMatch, String ifUnmodifiedSince) Update a Tier This operation can be used to update an existing policy.
List<Tier>	policiesUpdatePermissionPost(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince, TierPermission permissions) Update policy permission This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.
com.squareup.okhttp.Call	policiesUpdatePermissionPostAsync(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince, TierPermission permissions, ApiCallback<List<Tier>> callback) Update policy permission (asynchronously) This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.
ApiResponse<List<Tier>>	policiesUpdatePermissionPostWithHttpInfo(String tierName, String tierLevel, String ifMatch, String ifUnmodifiedSince, TierPermission permissions) Update policy permission This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottlingTierIndividualApi

public ThrottlingTierIndividualApi()

ThrottlingTierIndividualApi

public ThrottlingTierIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

policiesTierLevelTierNameDelete

public void policiesTierLevelTierNameDelete(String tierName,
                                            String tierLevel,
                                            String ifMatch,
                                            String ifUnmodifiedSince)
                                     throws ApiException

Delete a Tier This operation can be used to delete an existing policy. The only supported policy level is `api` policies. `DELETE https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Throws:

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

policiesTierLevelTierNameDeleteWithHttpInfo

public ApiResponse<Void> policiesTierLevelTierNameDeleteWithHttpInfo(String tierName,
                                                                     String tierLevel,
                                                                     String ifMatch,
                                                                     String ifUnmodifiedSince)
                                                              throws ApiException

Delete a Tier This operation can be used to delete an existing policy. The only supported policy level is `api` policies. `DELETE https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Void>

Throws:

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

policiesTierLevelTierNameDeleteAsync

public com.squareup.okhttp.Call policiesTierLevelTierNameDeleteAsync(String tierName,
                                                                     String tierLevel,
                                                                     String ifMatch,
                                                                     String ifUnmodifiedSince,
                                                                     ApiCallback<Void> callback)
                                                              throws ApiException

Delete a Tier (asynchronously) This operation can be used to delete an existing policy. The only supported policy level is `api` policies. `DELETE https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

policiesTierLevelTierNameGet

public Tier policiesTierLevelTierNameGet(String tierName,
                                         String tierLevel,
                                         String accept,
                                         String ifNoneMatch,
                                         String ifModifiedSince)
                                  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:

tierName - Tier name (required)

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

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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

Tier

Throws:

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

policiesTierLevelTierNameGetWithHttpInfo

public ApiResponse<Tier> policiesTierLevelTierNameGetWithHttpInfo(String tierName,
                                                                  String tierLevel,
                                                                  String accept,
                                                                  String ifNoneMatch,
                                                                  String ifModifiedSince)
                                                           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:

tierName - Tier name (required)

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

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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<Tier>

Throws:

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

policiesTierLevelTierNameGetAsync

public com.squareup.okhttp.Call policiesTierLevelTierNameGetAsync(String tierName,
                                                                  String tierLevel,
                                                                  String accept,
                                                                  String ifNoneMatch,
                                                                  String ifModifiedSince,
                                                                  ApiCallback<Tier> 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:

tierName - Tier name (required)

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

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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

policiesTierLevelTierNamePut

public Tier policiesTierLevelTierNamePut(String tierName,
                                         Tier body,
                                         String tierLevel,
                                         String contentType,
                                         String ifMatch,
                                         String ifUnmodifiedSince)
                                  throws ApiException

Update a Tier This operation can be used to update an existing policy. The only supported policy level is `api` policies. `PUT https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

body - Tier object that needs to be modified (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)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

Tier

Throws:

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

policiesTierLevelTierNamePutWithHttpInfo

public ApiResponse<Tier> policiesTierLevelTierNamePutWithHttpInfo(String tierName,
                                                                  Tier body,
                                                                  String tierLevel,
                                                                  String contentType,
                                                                  String ifMatch,
                                                                  String ifUnmodifiedSince)
                                                           throws ApiException

Update a Tier This operation can be used to update an existing policy. The only supported policy level is `api` policies. `PUT https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

body - Tier object that needs to be modified (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)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Tier>

Throws:

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

policiesTierLevelTierNamePutAsync

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

Update a Tier (asynchronously) This operation can be used to update an existing policy. The only supported policy level is `api` policies. `PUT https://127.0.0.1:9443/api/am/publisher/v1.0/policies/api/Low` **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:

tierName - Tier name (required)

body - Tier object that needs to be modified (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)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

policiesUpdatePermissionPost

public List<Tier> policiesUpdatePermissionPost(String tierName,
                                               String tierLevel,
                                               String ifMatch,
                                               String ifUnmodifiedSince,
                                               TierPermission permissions)
                                        throws ApiException

Update policy permission This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.

Parameters:

tierName - Name of the policy (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

permissions - (optional)

Returns:

List<Tier>

Throws:

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

policiesUpdatePermissionPostWithHttpInfo

public ApiResponse<List<Tier>> policiesUpdatePermissionPostWithHttpInfo(String tierName,
                                                                        String tierLevel,
                                                                        String ifMatch,
                                                                        String ifUnmodifiedSince,
                                                                        TierPermission permissions)
                                                                 throws ApiException

Update policy permission This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.

Parameters:

tierName - Name of the policy (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

permissions - (optional)

Returns:

ApiResponse<List<Tier>>

Throws:

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

policiesUpdatePermissionPostAsync

public com.squareup.okhttp.Call policiesUpdatePermissionPostAsync(String tierName,
                                                                  String tierLevel,
                                                                  String ifMatch,
                                                                  String ifUnmodifiedSince,
                                                                  TierPermission permissions,
                                                                  ApiCallback<List<Tier>> callback)
                                                           throws ApiException

Update policy permission (asynchronously) This operation can be used to update policy permissions which controls access for the particular policy based on the subscribers' roles.

Parameters:

tierName - Name of the policy (required)

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

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

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