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

Class ImportExportThrottlingPolicyApi

java.lang.Object

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

public class ImportExportThrottlingPolicyApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ImportExportThrottlingPolicyApi()
ImportExportThrottlingPolicyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ExportThrottlePolicyDTO	exportThrottlingPolicy(String policyId, String name, String type)	Export a Throttling Policy This operation can be used to export the details of a particular Throttling Policy.
okhttp3.Call	exportThrottlingPolicyAsync(String policyId, String name, String type, ApiCallback<ExportThrottlePolicyDTO> _callback)	Export a Throttling Policy (asynchronously) This operation can be used to export the details of a particular Throttling Policy.
okhttp3.Call	exportThrottlingPolicyCall(String policyId, String name, String type, ApiCallback _callback)	Build call for exportThrottlingPolicy
ApiResponse<ExportThrottlePolicyDTO>	exportThrottlingPolicyWithHttpInfo(String policyId, String name, String type)	Export a Throttling Policy This operation can be used to export the details of a particular Throttling Policy.
ApiClient	getApiClient()
void	importThrottlingPolicy(File file, Boolean overwrite)	Import a Throttling Policy This operation can be used to import a Throttling Policy
okhttp3.Call	importThrottlingPolicyAsync(File file, Boolean overwrite, ApiCallback<Void> _callback)	Import a Throttling Policy (asynchronously) This operation can be used to import a Throttling Policy
okhttp3.Call	importThrottlingPolicyCall(File file, Boolean overwrite, ApiCallback _callback)	Build call for importThrottlingPolicy
ApiResponse<Void>	importThrottlingPolicyWithHttpInfo(File file, Boolean overwrite)	Import a Throttling Policy This operation can be used to import a Throttling Policy
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportExportThrottlingPolicyApi

public ImportExportThrottlingPolicyApi()

ImportExportThrottlingPolicyApi

public ImportExportThrottlingPolicyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

exportThrottlingPolicyCall

public okhttp3.Call exportThrottlingPolicyCall(String policyId,
                                               String name,
                                               String type,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for exportThrottlingPolicy

Parameters:

policyId - UUID of the ThrottlingPolicy (optional)

name - Throttling Policy Name (optional)

type - Type of the Throttling Policy (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportThrottlingPolicy

public ExportThrottlePolicyDTO exportThrottlingPolicy(String policyId,
                                                      String name,
                                                      String type)
                                               throws ApiException

Export a Throttling Policy This operation can be used to export the details of a particular Throttling Policy.

Parameters:

policyId - UUID of the ThrottlingPolicy (optional)

name - Throttling Policy Name (optional)

type - Type of the Throttling Policy (optional)

Returns:

ExportThrottlePolicyDTO

Throws:

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

exportThrottlingPolicyWithHttpInfo

public ApiResponse<ExportThrottlePolicyDTO> exportThrottlingPolicyWithHttpInfo(String policyId,
                                                                               String name,
                                                                               String type)
                                                                        throws ApiException

Export a Throttling Policy This operation can be used to export the details of a particular Throttling Policy.

Parameters:

policyId - UUID of the ThrottlingPolicy (optional)

name - Throttling Policy Name (optional)

type - Type of the Throttling Policy (optional)

Returns:

ApiResponse<ExportThrottlePolicyDTO>

Throws:

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

exportThrottlingPolicyAsync

public okhttp3.Call exportThrottlingPolicyAsync(String policyId,
                                                String name,
                                                String type,
                                                ApiCallback<ExportThrottlePolicyDTO> _callback)
                                         throws ApiException

Export a Throttling Policy (asynchronously) This operation can be used to export the details of a particular Throttling Policy.

Parameters:

policyId - UUID of the ThrottlingPolicy (optional)

name - Throttling Policy Name (optional)

type - Type of the Throttling Policy (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

importThrottlingPolicyCall

public okhttp3.Call importThrottlingPolicyCall(File file,
                                               Boolean overwrite,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for importThrottlingPolicy

Parameters:

file - Json File (required)

overwrite - Update an existing throttlingpolicy with the same name (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

importThrottlingPolicy

public void importThrottlingPolicy(File file,
                                   Boolean overwrite)
                            throws ApiException

Import a Throttling Policy This operation can be used to import a Throttling Policy

Parameters:

file - Json File (required)

overwrite - Update an existing throttlingpolicy with the same name (optional)

Throws:

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

importThrottlingPolicyWithHttpInfo

public ApiResponse<Void> importThrottlingPolicyWithHttpInfo(File file,
                                                            Boolean overwrite)
                                                     throws ApiException

Import a Throttling Policy This operation can be used to import a Throttling Policy

Parameters:

file - Json File (required)

overwrite - Update an existing throttlingpolicy with the same name (optional)

Returns:

ApiResponse<Void>

Throws:

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

importThrottlingPolicyAsync

public okhttp3.Call importThrottlingPolicyAsync(File file,
                                                Boolean overwrite,
                                                ApiCallback<Void> _callback)
                                         throws ApiException

Import a Throttling Policy (asynchronously) This operation can be used to import a Throttling Policy

Parameters:

file - Json File (required)

overwrite - Update an existing throttlingpolicy with the same name (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