Package org.wso2.am.integration.clients.admin.api

Class CustomRulesCollectionApi

java.lang.Object

org.wso2.am.integration.clients.admin.api.CustomRulesCollectionApi

public class CustomRulesCollectionApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CustomRulesCollectionApi()
CustomRulesCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
CustomRuleListDTO	throttlingPoliciesCustomGet(String accept, String ifNoneMatch, String ifModifiedSince)	Get all Custom Rules Retrieves all custom rules.
okhttp3.Call	throttlingPoliciesCustomGetAsync(String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<CustomRuleListDTO> _callback)	Get all Custom Rules (asynchronously) Retrieves all custom rules.
okhttp3.Call	throttlingPoliciesCustomGetCall(String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback _callback)	Build call for throttlingPoliciesCustomGet
ApiResponse<CustomRuleListDTO>	throttlingPoliciesCustomGetWithHttpInfo(String accept, String ifNoneMatch, String ifModifiedSince)	Get all Custom Rules Retrieves all custom rules.
CustomRuleDTO	throttlingPoliciesCustomPost(String contentType, CustomRuleDTO customRuleDTO)	Add a Custom Rule Adds a new custom rule.
okhttp3.Call	throttlingPoliciesCustomPostAsync(String contentType, CustomRuleDTO customRuleDTO, ApiCallback<CustomRuleDTO> _callback)	Add a Custom Rule (asynchronously) Adds a new custom rule.
okhttp3.Call	throttlingPoliciesCustomPostCall(String contentType, CustomRuleDTO customRuleDTO, ApiCallback _callback)	Build call for throttlingPoliciesCustomPost
ApiResponse<CustomRuleDTO>	throttlingPoliciesCustomPostWithHttpInfo(String contentType, CustomRuleDTO customRuleDTO)	Add a Custom Rule Adds a new custom rule.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomRulesCollectionApi

public CustomRulesCollectionApi()

CustomRulesCollectionApi

public CustomRulesCollectionApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesCustomGetCall

public okhttp3.Call throttlingPoliciesCustomGetCall(String accept,
 String ifNoneMatch,
 String ifModifiedSince,
 ApiCallback _callback)
                                             throws ApiException

Build call for throttlingPoliciesCustomGet

Parameters:

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 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 - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesCustomGet

public CustomRuleListDTO throttlingPoliciesCustomGet(String accept,
 String ifNoneMatch,
 String ifModifiedSince)
                                              throws ApiException

Get all Custom Rules Retrieves all custom rules. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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 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:

CustomRuleListDTO

Throws:

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

throttlingPoliciesCustomGetWithHttpInfo

public ApiResponse<CustomRuleListDTO> throttlingPoliciesCustomGetWithHttpInfo(String accept,
 String ifNoneMatch,
 String ifModifiedSince)
                                                                       throws ApiException

Get all Custom Rules Retrieves all custom rules. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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 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<CustomRuleListDTO>

Throws:

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

throttlingPoliciesCustomGetAsync

public okhttp3.Call throttlingPoliciesCustomGetAsync(String accept,
 String ifNoneMatch,
 String ifModifiedSince,
 ApiCallback<CustomRuleListDTO> _callback)
                                              throws ApiException

Get all Custom Rules (asynchronously) Retrieves all custom rules. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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

throttlingPoliciesCustomPostCall

public okhttp3.Call throttlingPoliciesCustomPostCall(String contentType,
 CustomRuleDTO customRuleDTO,
 ApiCallback _callback)
                                              throws ApiException

Build call for throttlingPoliciesCustomPost

Parameters:

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

customRuleDTO - Custom Rule object that should to be added (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesCustomPost

public CustomRuleDTO throttlingPoliciesCustomPost(String contentType,
 CustomRuleDTO customRuleDTO)
                                           throws ApiException

Add a Custom Rule Adds a new custom rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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

customRuleDTO - Custom Rule object that should to be added (required)

Returns:

CustomRuleDTO

Throws:

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

throttlingPoliciesCustomPostWithHttpInfo

public ApiResponse<CustomRuleDTO> throttlingPoliciesCustomPostWithHttpInfo(String contentType,
 CustomRuleDTO customRuleDTO)
                                                                    throws ApiException

Add a Custom Rule Adds a new custom rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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

customRuleDTO - Custom Rule object that should to be added (required)

Returns:

ApiResponse<CustomRuleDTO>

Throws:

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

throttlingPoliciesCustomPostAsync

public okhttp3.Call throttlingPoliciesCustomPostAsync(String contentType,
 CustomRuleDTO customRuleDTO,
 ApiCallback<CustomRuleDTO> _callback)
                                               throws ApiException

Add a Custom Rule (asynchronously) Adds a new custom rule. **NOTE:** * Only super tenant users are allowed for this operation.

Parameters:

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

customRuleDTO - Custom Rule object that should to be added (required)

_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