org.wso2.carbon.apimgt.samples.utils.admin.rest.client.api

Class CustomRulesIndividualApi

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.admin.rest.client.api.CustomRulesIndividualApi

public class CustomRulesIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomRulesIndividualApi()
CustomRulesIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	throttlingPoliciesCustomRuleIdDelete(String ruleId, String ifMatch, String ifUnmodifiedSince) Delete a Custom Rule Delete a Custom Rule.
com.squareup.okhttp.Call	throttlingPoliciesCustomRuleIdDeleteAsync(String ruleId, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Delete a Custom Rule (asynchronously) Delete a Custom Rule.
ApiResponse<Void>	throttlingPoliciesCustomRuleIdDeleteWithHttpInfo(String ruleId, String ifMatch, String ifUnmodifiedSince) Delete a Custom Rule Delete a Custom Rule.
CustomRule	throttlingPoliciesCustomRuleIdGet(String ruleId, String ifNoneMatch, String ifModifiedSince) Get a Custom Rule Retrieves a Custom Rule.
com.squareup.okhttp.Call	throttlingPoliciesCustomRuleIdGetAsync(String ruleId, String ifNoneMatch, String ifModifiedSince, ApiCallback<CustomRule> callback) Get a Custom Rule (asynchronously) Retrieves a Custom Rule.
ApiResponse<CustomRule>	throttlingPoliciesCustomRuleIdGetWithHttpInfo(String ruleId, String ifNoneMatch, String ifModifiedSince) Get a Custom Rule Retrieves a Custom Rule.
CustomRule	throttlingPoliciesCustomRuleIdPut(String ruleId, CustomRule body, String contentType, String ifMatch, String ifUnmodifiedSince) Update a Custom Rule Updates an existing Custom Rule.
com.squareup.okhttp.Call	throttlingPoliciesCustomRuleIdPutAsync(String ruleId, CustomRule body, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<CustomRule> callback) Update a Custom Rule (asynchronously) Updates an existing Custom Rule.
ApiResponse<CustomRule>	throttlingPoliciesCustomRuleIdPutWithHttpInfo(String ruleId, CustomRule body, String contentType, String ifMatch, String ifUnmodifiedSince) Update a Custom Rule Updates an existing Custom Rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomRulesIndividualApi

public CustomRulesIndividualApi()

CustomRulesIndividualApi

public CustomRulesIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesCustomRuleIdDelete

public void throttlingPoliciesCustomRuleIdDelete(String ruleId,
                                                 String ifMatch,
                                                 String ifUnmodifiedSince)
                                          throws ApiException

Delete a Custom Rule Delete a Custom Rule. We need to provide the Id of the policy as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (optional)

Throws:

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

throttlingPoliciesCustomRuleIdDeleteWithHttpInfo

public ApiResponse<Void> throttlingPoliciesCustomRuleIdDeleteWithHttpInfo(String ruleId,
                                                                          String ifMatch,
                                                                          String ifUnmodifiedSince)
                                                                   throws ApiException

Delete a Custom Rule Delete a Custom Rule. We need to provide the Id of the policy as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (optional)

Returns:

ApiResponse<Void>

Throws:

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

throttlingPoliciesCustomRuleIdDeleteAsync

public com.squareup.okhttp.Call throttlingPoliciesCustomRuleIdDeleteAsync(String ruleId,
                                                                          String ifMatch,
                                                                          String ifUnmodifiedSince,
                                                                          ApiCallback<Void> callback)
                                                                   throws ApiException

Delete a Custom Rule (asynchronously) Delete a Custom Rule. We need to provide the Id of the policy as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (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

throttlingPoliciesCustomRuleIdGet

public CustomRule throttlingPoliciesCustomRuleIdGet(String ruleId,
                                                    String ifNoneMatch,
                                                    String ifModifiedSince)
                                             throws ApiException

Get a Custom Rule Retrieves a Custom Rule. We need to provide the policy Id as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

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

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

Returns:

CustomRule

Throws:

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

throttlingPoliciesCustomRuleIdGetWithHttpInfo

public ApiResponse<CustomRule> throttlingPoliciesCustomRuleIdGetWithHttpInfo(String ruleId,
                                                                             String ifNoneMatch,
                                                                             String ifModifiedSince)
                                                                      throws ApiException

Get a Custom Rule Retrieves a Custom Rule. We need to provide the policy Id as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

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

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

Returns:

ApiResponse<CustomRule>

Throws:

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

throttlingPoliciesCustomRuleIdGetAsync

public com.squareup.okhttp.Call throttlingPoliciesCustomRuleIdGetAsync(String ruleId,
                                                                       String ifNoneMatch,
                                                                       String ifModifiedSince,
                                                                       ApiCallback<CustomRule> callback)
                                                                throws ApiException

Get a Custom Rule (asynchronously) Retrieves a Custom Rule. We need to provide the policy Id as a path parameter. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

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

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (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

throttlingPoliciesCustomRuleIdPut

public CustomRule throttlingPoliciesCustomRuleIdPut(String ruleId,
                                                    CustomRule body,
                                                    String contentType,
                                                    String ifMatch,
                                                    String ifUnmodifiedSince)
                                             throws ApiException

Update a Custom Rule Updates an existing Custom Rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

body - Policy object that needs to be modified (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (optional)

Returns:

CustomRule

Throws:

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

throttlingPoliciesCustomRuleIdPutWithHttpInfo

public ApiResponse<CustomRule> throttlingPoliciesCustomRuleIdPutWithHttpInfo(String ruleId,
                                                                             CustomRule body,
                                                                             String contentType,
                                                                             String ifMatch,
                                                                             String ifUnmodifiedSince)
                                                                      throws ApiException

Update a Custom Rule Updates an existing Custom Rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

body - Policy object that needs to be modified (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (optional)

Returns:

ApiResponse<CustomRule>

Throws:

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

throttlingPoliciesCustomRuleIdPutAsync

public com.squareup.okhttp.Call throttlingPoliciesCustomRuleIdPutAsync(String ruleId,
                                                                       CustomRule body,
                                                                       String contentType,
                                                                       String ifMatch,
                                                                       String ifUnmodifiedSince,
                                                                       ApiCallback<CustomRule> callback)
                                                                throws ApiException

Update a Custom Rule (asynchronously) Updates an existing Custom Rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

ruleId - Custom rule UUID (required)

body - Policy object that needs to be modified (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

ifMatch - Validator for conditional requests; based on ETag (Will be supported in future). (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header (Will be supported in future). (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