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 and Description
SubscriptionPolicyIndividualApi()
SubscriptionPolicyIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and 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 specifying the Id of the policy as a path paramter.
com.squareup.okhttp.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 specifying the Id of the policy as a path paramter.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPolicyIdDeleteCall(String policyId, String ifMatch, String ifUnmodifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) 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 specifying the Id of the policy as a path paramter.
SubscriptionThrottlePolicyDTO	throttlingPoliciesSubscriptionPolicyIdGet(String policyId, String ifNoneMatch, String ifModifiedSince) Get a Subscription Policy Retrieve a single subscription-level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPolicyIdGetAsync(String policyId, String ifNoneMatch, String ifModifiedSince, ApiCallback<SubscriptionThrottlePolicyDTO> callback) Get a Subscription Policy (asynchronously) Retrieve a single subscription-level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPolicyIdGetCall(String policyId, String ifNoneMatch, String ifModifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesSubscriptionPolicyIdGet
ApiResponse<SubscriptionThrottlePolicyDTO>	throttlingPoliciesSubscriptionPolicyIdGetWithHttpInfo(String policyId, String ifNoneMatch, String ifModifiedSince) Get a Subscription Policy Retrieve a single subscription-level throttling policy.
SubscriptionThrottlePolicyDTO	throttlingPoliciesSubscriptionPolicyIdPut(String policyId, SubscriptionThrottlePolicyDTO body, String contentType, String ifMatch, String ifUnmodifiedSince) Update a Subscription Policy Updates an existing subscription-level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPolicyIdPutAsync(String policyId, SubscriptionThrottlePolicyDTO body, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<SubscriptionThrottlePolicyDTO> callback) Update a Subscription Policy (asynchronously) Updates an existing subscription-level throttling policy.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPolicyIdPutCall(String policyId, SubscriptionThrottlePolicyDTO body, String contentType, String ifMatch, String ifUnmodifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesSubscriptionPolicyIdPut
ApiResponse<SubscriptionThrottlePolicyDTO>	throttlingPoliciesSubscriptionPolicyIdPutWithHttpInfo(String policyId, SubscriptionThrottlePolicyDTO body, String contentType, 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 Detail

SubscriptionPolicyIndividualApi

public SubscriptionPolicyIndividualApi()

SubscriptionPolicyIndividualApi

public SubscriptionPolicyIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesSubscriptionPolicyIdDeleteCall

public com.squareup.okhttp.Call throttlingPoliciesSubscriptionPolicyIdDeleteCall(String policyId,
                                                                                 String ifMatch,
                                                                                 String ifUnmodifiedSince,
                                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                          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)

progressListener - Progress listener

progressRequestListener - Progress request listener

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 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 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 com.squareup.okhttp.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 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 com.squareup.okhttp.Call throttlingPoliciesSubscriptionPolicyIdGetCall(String policyId,
                                                                              String ifNoneMatch,
                                                                              String ifModifiedSince,
                                                                              ProgressResponseBody.ProgressListener progressListener,
                                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                       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)

progressListener - Progress listener

progressRequestListener - Progress request listener

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 Retrieve a single subscription-level throttling policy. We should provide the Id of the policy as a path parameter.

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 Retrieve a single subscription-level throttling policy. We should provide the Id of the policy as a path parameter.

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 com.squareup.okhttp.Call throttlingPoliciesSubscriptionPolicyIdGetAsync(String policyId,
                                                                               String ifNoneMatch,
                                                                               String ifModifiedSince,
                                                                               ApiCallback<SubscriptionThrottlePolicyDTO> callback)
                                                                        throws ApiException

Get a Subscription Policy (asynchronously) Retrieve a single subscription-level throttling policy. We should provide the Id of the policy as a path parameter.

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 com.squareup.okhttp.Call throttlingPoliciesSubscriptionPolicyIdPutCall(String policyId,
                                                                              SubscriptionThrottlePolicyDTO body,
                                                                              String contentType,
                                                                              String ifMatch,
                                                                              String ifUnmodifiedSince,
                                                                              ProgressResponseBody.ProgressListener progressListener,
                                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                       throws ApiException

Build call for throttlingPoliciesSubscriptionPolicyIdPut

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionPolicyIdPut

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

Update a Subscription Policy Updates an existing subscription-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:

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,
                                                                                                        SubscriptionThrottlePolicyDTO body,
                                                                                                        String contentType,
                                                                                                        String ifMatch,
                                                                                                        String ifUnmodifiedSince)
                                                                                                 throws ApiException

Update a Subscription Policy Updates an existing subscription-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<SubscriptionThrottlePolicyDTO>

Throws:

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

throttlingPoliciesSubscriptionPolicyIdPutAsync

public com.squareup.okhttp.Call throttlingPoliciesSubscriptionPolicyIdPutAsync(String policyId,
                                                                               SubscriptionThrottlePolicyDTO body,
                                                                               String contentType,
                                                                               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)

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