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

Class SubscriptionPolicyIndividualApi

java.lang.Object

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

public class SubscriptionPolicyIndividualApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SubscriptionPolicyIndividualApi()
SubscriptionPolicyIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	throttlingPoliciesSubscriptionPolicyIdDelete(String policyId, String ifMatch, String ifUnmodifiedSince)	Delete a Subscription Policy This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdDeleteAsync(String policyId, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> _callback)	Delete a Subscription Policy (asynchronously) This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdDeleteCall(String policyId, String ifMatch, String ifUnmodifiedSince, ApiCallback _callback)	Build call for throttlingPoliciesSubscriptionPolicyIdDelete
ApiResponse<Void>	throttlingPoliciesSubscriptionPolicyIdDeleteWithHttpInfo(String policyId, String ifMatch, String ifUnmodifiedSince)	Delete a Subscription Policy This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.
SubscriptionThrottlePolicyDTO	throttlingPoliciesSubscriptionPolicyIdGet(String policyId, String ifNoneMatch, String ifModifiedSince)	Get a Subscription Policy This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdGetAsync(String policyId, String ifNoneMatch, String ifModifiedSince, ApiCallback<SubscriptionThrottlePolicyDTO> _callback)	Get a Subscription Policy (asynchronously) This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdGetCall(String policyId, String ifNoneMatch, String ifModifiedSince, ApiCallback _callback)	Build call for throttlingPoliciesSubscriptionPolicyIdGet
ApiResponse<SubscriptionThrottlePolicyDTO>	throttlingPoliciesSubscriptionPolicyIdGetWithHttpInfo(String policyId, String ifNoneMatch, String ifModifiedSince)	Get a Subscription Policy This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter
SubscriptionThrottlePolicyDTO	throttlingPoliciesSubscriptionPolicyIdPut(String policyId, String contentType, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO, String ifMatch, String ifUnmodifiedSince)	Update a Subscription Policy Updates an existing subscription level throttling policy.
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdPutAsync(String policyId, String contentType, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO, String ifMatch, String ifUnmodifiedSince, ApiCallback<SubscriptionThrottlePolicyDTO> _callback)	Update a Subscription Policy (asynchronously) Updates an existing subscription level throttling policy.
okhttp3.Call	throttlingPoliciesSubscriptionPolicyIdPutCall(String policyId, String contentType, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO, String ifMatch, String ifUnmodifiedSince, ApiCallback _callback)	Build call for throttlingPoliciesSubscriptionPolicyIdPut
ApiResponse<SubscriptionThrottlePolicyDTO>	throttlingPoliciesSubscriptionPolicyIdPutWithHttpInfo(String policyId, String contentType, SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO, String ifMatch, String ifUnmodifiedSince)	Update a Subscription Policy Updates an existing subscription level throttling policy.

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionPolicyIndividualApi

public SubscriptionPolicyIndividualApi()

SubscriptionPolicyIndividualApi

public SubscriptionPolicyIndividualApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesSubscriptionPolicyIdDeleteCall

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdDeleteCall(String policyId,
 String ifMatch,
 String ifUnmodifiedSince,
 ApiCallback _callback)
                                                              throws ApiException

Build call for throttlingPoliciesSubscriptionPolicyIdDelete

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

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionPolicyIdDelete

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

Delete a Subscription Policy This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.

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

throttlingPoliciesSubscriptionPolicyIdDeleteWithHttpInfo

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

Delete a Subscription Policy This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.

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

throttlingPoliciesSubscriptionPolicyIdDeleteAsync

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdDeleteAsync(String policyId,
 String ifMatch,
 String ifUnmodifiedSince,
 ApiCallback<Void> _callback)
                                                               throws ApiException

Delete a Subscription Policy (asynchronously) This operation can be used to delete a subscription level throttling policy by specifying the Id of the policy as a path paramter.

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

throttlingPoliciesSubscriptionPolicyIdGetCall

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdGetCall(String policyId,
 String ifNoneMatch,
 String ifModifiedSince,
 ApiCallback _callback)
                                                           throws ApiException

Build call for throttlingPoliciesSubscriptionPolicyIdGet

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

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionPolicyIdGet

public SubscriptionThrottlePolicyDTO throttlingPoliciesSubscriptionPolicyIdGet(String policyId,
 String ifNoneMatch,
 String ifModifiedSince)
                                                                        throws ApiException

Get a Subscription Policy This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter

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:

SubscriptionThrottlePolicyDTO

Throws:

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

throttlingPoliciesSubscriptionPolicyIdGetWithHttpInfo

public ApiResponse<SubscriptionThrottlePolicyDTO> throttlingPoliciesSubscriptionPolicyIdGetWithHttpInfo(String policyId,
 String ifNoneMatch,
 String ifModifiedSince)
                                                                                                 throws ApiException

Get a Subscription Policy This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter

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

Throws:

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

throttlingPoliciesSubscriptionPolicyIdGetAsync

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdGetAsync(String policyId,
 String ifNoneMatch,
 String ifModifiedSince,
 ApiCallback<SubscriptionThrottlePolicyDTO> _callback)
                                                            throws ApiException

Get a Subscription Policy (asynchronously) This operation can be used to retrieves subscription level throttling policy by specifying the Id of the policy as a path paramter

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

throttlingPoliciesSubscriptionPolicyIdPutCall

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdPutCall(String policyId,
 String contentType,
 SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO,
 String ifMatch,
 String ifUnmodifiedSince,
 ApiCallback _callback)
                                                           throws ApiException

Build call for throttlingPoliciesSubscriptionPolicyIdPut

Parameters:

policyId - Thorttle policy UUID (required)

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

subscriptionThrottlePolicyDTO - Policy object that needs to be modified (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 - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionPolicyIdPut

public SubscriptionThrottlePolicyDTO throttlingPoliciesSubscriptionPolicyIdPut(String policyId,
 String contentType,
 SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO,
 String ifMatch,
 String ifUnmodifiedSince)
                                                                        throws ApiException

Update a Subscription Policy Updates an existing subscription level throttling policy.

Parameters:

policyId - Thorttle policy UUID (required)

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

subscriptionThrottlePolicyDTO - Policy object that needs to be modified (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:

SubscriptionThrottlePolicyDTO

Throws:

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

throttlingPoliciesSubscriptionPolicyIdPutWithHttpInfo

public ApiResponse<SubscriptionThrottlePolicyDTO> throttlingPoliciesSubscriptionPolicyIdPutWithHttpInfo(String policyId,
 String contentType,
 SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO,
 String ifMatch,
 String ifUnmodifiedSince)
                                                                                                 throws ApiException

Update a Subscription Policy Updates an existing subscription level throttling policy.

Parameters:

policyId - Thorttle policy UUID (required)

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

subscriptionThrottlePolicyDTO - Policy object that needs to be modified (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<SubscriptionThrottlePolicyDTO>

Throws:

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

throttlingPoliciesSubscriptionPolicyIdPutAsync

public okhttp3.Call throttlingPoliciesSubscriptionPolicyIdPutAsync(String policyId,
 String contentType,
 SubscriptionThrottlePolicyDTO subscriptionThrottlePolicyDTO,
 String ifMatch,
 String ifUnmodifiedSince,
 ApiCallback<SubscriptionThrottlePolicyDTO> _callback)
                                                            throws ApiException

Update a Subscription Policy (asynchronously) Updates an existing subscription level throttling policy.

Parameters:

policyId - Thorttle policy UUID (required)

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

subscriptionThrottlePolicyDTO - Policy object that needs to be modified (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