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

Class CustomRulesCollectionApi

java.lang.Object

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

public class CustomRulesCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomRulesCollectionApi()
CustomRulesCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
CustomRuleList	throttlingPoliciesCustomGet(String accept, String ifNoneMatch, String ifModifiedSince) Get all Custom Rules Retrieves all Custom Rules.
com.squareup.okhttp.Call	throttlingPoliciesCustomGetAsync(String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<CustomRuleList> callback) Get all Custom Rules (asynchronously) Retrieves all Custom Rules.
ApiResponse<CustomRuleList>	throttlingPoliciesCustomGetWithHttpInfo(String accept, String ifNoneMatch, String ifModifiedSince) Get all Custom Rules Retrieves all Custom Rules.
CustomRule	throttlingPoliciesCustomPost(CustomRule body, String contentType) Add a Custom Rule Adds a new Custom Rule.
com.squareup.okhttp.Call	throttlingPoliciesCustomPostAsync(CustomRule body, String contentType, ApiCallback<CustomRule> callback) Add a Custom Rule (asynchronously) Adds a new Custom Rule.
ApiResponse<CustomRule>	throttlingPoliciesCustomPostWithHttpInfo(CustomRule body, String contentType) 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 Detail

CustomRulesCollectionApi

public CustomRulesCollectionApi()

CustomRulesCollectionApi

public CustomRulesCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesCustomGet

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

CustomRuleList

Throws:

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

throttlingPoliciesCustomGetWithHttpInfo

public ApiResponse<CustomRuleList> 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<CustomRuleList>

Throws:

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

throttlingPoliciesCustomGetAsync

public com.squareup.okhttp.Call throttlingPoliciesCustomGetAsync(String accept,
                                                                 String ifNoneMatch,
                                                                 String ifModifiedSince,
                                                                 ApiCallback<CustomRuleList> 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

throttlingPoliciesCustomPost

public CustomRule throttlingPoliciesCustomPost(CustomRule body,
                                               String contentType)
                                        throws ApiException

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

Parameters:

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

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

Returns:

CustomRule

Throws:

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

throttlingPoliciesCustomPostWithHttpInfo

public ApiResponse<CustomRule> throttlingPoliciesCustomPostWithHttpInfo(CustomRule body,
                                                                        String contentType)
                                                                 throws ApiException

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

Parameters:

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

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

Returns:

ApiResponse<CustomRule>

Throws:

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

throttlingPoliciesCustomPostAsync

public com.squareup.okhttp.Call throttlingPoliciesCustomPostAsync(CustomRule body,
                                                                  String contentType,
                                                                  ApiCallback<CustomRule> callback)
                                                           throws ApiException

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

Parameters:

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

contentType - Media type of the entity in the body. Default is application/json. (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