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

Class AdvancedPolicyIndividualApi

java.lang.Object

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

public class AdvancedPolicyIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AdvancedPolicyIndividualApi()
AdvancedPolicyIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	throttlingPoliciesAdvancedPolicyIdDelete(String policyId, String ifMatch, String ifUnmodifiedSince) Delete an Advanced Throttling Policy Deletes an Advanced level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesAdvancedPolicyIdDeleteAsync(String policyId, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Delete an Advanced Throttling Policy (asynchronously) Deletes an Advanced level throttling policy.
ApiResponse<Void>	throttlingPoliciesAdvancedPolicyIdDeleteWithHttpInfo(String policyId, String ifMatch, String ifUnmodifiedSince) Delete an Advanced Throttling Policy Deletes an Advanced level throttling policy.
AdvancedThrottlePolicy	throttlingPoliciesAdvancedPolicyIdGet(String policyId, String ifNoneMatch, String ifModifiedSince) Get an Advanced Policy Retrieves an Advanced Policy.
com.squareup.okhttp.Call	throttlingPoliciesAdvancedPolicyIdGetAsync(String policyId, String ifNoneMatch, String ifModifiedSince, ApiCallback<AdvancedThrottlePolicy> callback) Get an Advanced Policy (asynchronously) Retrieves an Advanced Policy.
ApiResponse<AdvancedThrottlePolicy>	throttlingPoliciesAdvancedPolicyIdGetWithHttpInfo(String policyId, String ifNoneMatch, String ifModifiedSince) Get an Advanced Policy Retrieves an Advanced Policy.
AdvancedThrottlePolicy	throttlingPoliciesAdvancedPolicyIdPut(String policyId, AdvancedThrottlePolicy body, String contentType, String ifMatch, String ifUnmodifiedSince) Update an Advanced Throttling Policy Updates an existing Advanced level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesAdvancedPolicyIdPutAsync(String policyId, AdvancedThrottlePolicy body, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<AdvancedThrottlePolicy> callback) Update an Advanced Throttling Policy (asynchronously) Updates an existing Advanced level throttling policy.
ApiResponse<AdvancedThrottlePolicy>	throttlingPoliciesAdvancedPolicyIdPutWithHttpInfo(String policyId, AdvancedThrottlePolicy body, String contentType, String ifMatch, String ifUnmodifiedSince) Update an Advanced Throttling Policy Updates an existing Advanced level throttling policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedPolicyIndividualApi

public AdvancedPolicyIndividualApi()

AdvancedPolicyIndividualApi

public AdvancedPolicyIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesAdvancedPolicyIdDelete

public void throttlingPoliciesAdvancedPolicyIdDelete(String policyId,
                                                     String ifMatch,
                                                     String ifUnmodifiedSince)
                                              throws ApiException

Delete an Advanced Throttling Policy Deletes an Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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

throttlingPoliciesAdvancedPolicyIdDeleteWithHttpInfo

public ApiResponse<Void> throttlingPoliciesAdvancedPolicyIdDeleteWithHttpInfo(String policyId,
                                                                              String ifMatch,
                                                                              String ifUnmodifiedSince)
                                                                       throws ApiException

Delete an Advanced Throttling Policy Deletes an Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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

throttlingPoliciesAdvancedPolicyIdDeleteAsync

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

Delete an Advanced Throttling Policy (asynchronously) Deletes an Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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

throttlingPoliciesAdvancedPolicyIdGet

public AdvancedThrottlePolicy throttlingPoliciesAdvancedPolicyIdGet(String policyId,
                                                                    String ifNoneMatch,
                                                                    String ifModifiedSince)
                                                             throws ApiException

Get an Advanced Policy Retrieves an Advanced Policy.

Parameters:

policyId - Thorttle policy 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:

AdvancedThrottlePolicy

Throws:

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

throttlingPoliciesAdvancedPolicyIdGetWithHttpInfo

public ApiResponse<AdvancedThrottlePolicy> throttlingPoliciesAdvancedPolicyIdGetWithHttpInfo(String policyId,
                                                                                             String ifNoneMatch,
                                                                                             String ifModifiedSince)
                                                                                      throws ApiException

Get an Advanced Policy Retrieves an Advanced Policy.

Parameters:

policyId - Thorttle policy 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<AdvancedThrottlePolicy>

Throws:

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

throttlingPoliciesAdvancedPolicyIdGetAsync

public com.squareup.okhttp.Call throttlingPoliciesAdvancedPolicyIdGetAsync(String policyId,
                                                                           String ifNoneMatch,
                                                                           String ifModifiedSince,
                                                                           ApiCallback<AdvancedThrottlePolicy> callback)
                                                                    throws ApiException

Get an Advanced Policy (asynchronously) Retrieves an Advanced Policy.

Parameters:

policyId - Thorttle policy 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

throttlingPoliciesAdvancedPolicyIdPut

public AdvancedThrottlePolicy throttlingPoliciesAdvancedPolicyIdPut(String policyId,
                                                                    AdvancedThrottlePolicy body,
                                                                    String contentType,
                                                                    String ifMatch,
                                                                    String ifUnmodifiedSince)
                                                             throws ApiException

Update an Advanced Throttling Policy Updates an existing Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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:

AdvancedThrottlePolicy

Throws:

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

throttlingPoliciesAdvancedPolicyIdPutWithHttpInfo

public ApiResponse<AdvancedThrottlePolicy> throttlingPoliciesAdvancedPolicyIdPutWithHttpInfo(String policyId,
                                                                                             AdvancedThrottlePolicy body,
                                                                                             String contentType,
                                                                                             String ifMatch,
                                                                                             String ifUnmodifiedSince)
                                                                                      throws ApiException

Update an Advanced Throttling Policy Updates an existing Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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<AdvancedThrottlePolicy>

Throws:

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

throttlingPoliciesAdvancedPolicyIdPutAsync

public com.squareup.okhttp.Call throttlingPoliciesAdvancedPolicyIdPutAsync(String policyId,
                                                                           AdvancedThrottlePolicy body,
                                                                           String contentType,
                                                                           String ifMatch,
                                                                           String ifUnmodifiedSince,
                                                                           ApiCallback<AdvancedThrottlePolicy> callback)
                                                                    throws ApiException

Update an Advanced Throttling Policy (asynchronously) Updates an existing Advanced level throttling policy.

Parameters:

policyId - Thorttle policy 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