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

Class SubscriptionPolicyCollectionApi

java.lang.Object

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

public class SubscriptionPolicyCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionPolicyCollectionApi()
SubscriptionPolicyCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
SubscriptionThrottlePolicyListDTO	throttlingPoliciesSubscriptionGet(String accept, String ifNoneMatch, String ifModifiedSince) Get all Subscription Throttling Policies This operation can be used to retrieve all Subscription level throttling policies.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionGetAsync(String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<SubscriptionThrottlePolicyListDTO> callback) Get all Subscription Throttling Policies (asynchronously) This operation can be used to retrieve all Subscription level throttling policies.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionGetCall(String accept, String ifNoneMatch, String ifModifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesSubscriptionGet
ApiResponse<SubscriptionThrottlePolicyListDTO>	throttlingPoliciesSubscriptionGetWithHttpInfo(String accept, String ifNoneMatch, String ifModifiedSince) Get all Subscription Throttling Policies This operation can be used to retrieve all Subscription level throttling policies.
SubscriptionThrottlePolicyDTO	throttlingPoliciesSubscriptionPost(SubscriptionThrottlePolicyDTO body, String contentType) Add a Subscription Throttling Policy This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPostAsync(SubscriptionThrottlePolicyDTO body, String contentType, ApiCallback<SubscriptionThrottlePolicyDTO> callback) Add a Subscription Throttling Policy (asynchronously) This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.
com.squareup.okhttp.Call	throttlingPoliciesSubscriptionPostCall(SubscriptionThrottlePolicyDTO body, String contentType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for throttlingPoliciesSubscriptionPost
ApiResponse<SubscriptionThrottlePolicyDTO>	throttlingPoliciesSubscriptionPostWithHttpInfo(SubscriptionThrottlePolicyDTO body, String contentType) Add a Subscription Throttling Policy This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionPolicyCollectionApi

public SubscriptionPolicyCollectionApi()

SubscriptionPolicyCollectionApi

public SubscriptionPolicyCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

throttlingPoliciesSubscriptionGetCall

public com.squareup.okhttp.Call throttlingPoliciesSubscriptionGetCall(String accept,
                                                                      String ifNoneMatch,
                                                                      String ifModifiedSince,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for throttlingPoliciesSubscriptionGet

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)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionGet

public SubscriptionThrottlePolicyListDTO throttlingPoliciesSubscriptionGet(String accept,
                                                                           String ifNoneMatch,
                                                                           String ifModifiedSince)
                                                                    throws ApiException

Get all Subscription Throttling Policies This operation can be used to retrieve all Subscription level throttling policies.

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:

SubscriptionThrottlePolicyListDTO

Throws:

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

throttlingPoliciesSubscriptionGetWithHttpInfo

public ApiResponse<SubscriptionThrottlePolicyListDTO> throttlingPoliciesSubscriptionGetWithHttpInfo(String accept,
                                                                                                    String ifNoneMatch,
                                                                                                    String ifModifiedSince)
                                                                                             throws ApiException

Get all Subscription Throttling Policies This operation can be used to retrieve all Subscription level throttling policies.

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

Throws:

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

throttlingPoliciesSubscriptionGetAsync

public com.squareup.okhttp.Call throttlingPoliciesSubscriptionGetAsync(String accept,
                                                                       String ifNoneMatch,
                                                                       String ifModifiedSince,
                                                                       ApiCallback<SubscriptionThrottlePolicyListDTO> callback)
                                                                throws ApiException

Get all Subscription Throttling Policies (asynchronously) This operation can be used to retrieve all Subscription level throttling policies.

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

throttlingPoliciesSubscriptionPostCall

public com.squareup.okhttp.Call throttlingPoliciesSubscriptionPostCall(SubscriptionThrottlePolicyDTO body,
                                                                       String contentType,
                                                                       ProgressResponseBody.ProgressListener progressListener,
                                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                throws ApiException

Build call for throttlingPoliciesSubscriptionPost

Parameters:

body - Subscripion level policy object that should to be added (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

throttlingPoliciesSubscriptionPost

public SubscriptionThrottlePolicyDTO throttlingPoliciesSubscriptionPost(SubscriptionThrottlePolicyDTO body,
                                                                        String contentType)
                                                                 throws ApiException

Add a Subscription Throttling Policy This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.

Parameters:

body - Subscripion level policy object that should to be added (required)

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

Returns:

SubscriptionThrottlePolicyDTO

Throws:

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

throttlingPoliciesSubscriptionPostWithHttpInfo

public ApiResponse<SubscriptionThrottlePolicyDTO> throttlingPoliciesSubscriptionPostWithHttpInfo(SubscriptionThrottlePolicyDTO body,
                                                                                                 String contentType)
                                                                                          throws ApiException

Add a Subscription Throttling Policy This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.

Parameters:

body - Subscripion level policy object that should to be added (required)

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

Returns:

ApiResponse<SubscriptionThrottlePolicyDTO>

Throws:

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

throttlingPoliciesSubscriptionPostAsync

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

Add a Subscription Throttling Policy (asynchronously) This operation can be used to add a Subscription level throttling policy specifying the details of the policy in the payload.

Parameters:

body - Subscripion level policy 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