org.wso2.am.integration.clients.publisher.api.v1

Class OperationPoliciesApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.OperationPoliciesApi

public class OperationPoliciesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
OperationPoliciesApi()
OperationPoliciesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
OperationPolicyDataDTO	addCommonOperationPolicy(File policySpecFile, File synapsePolicyDefinitionFile, File ccPolicyDefinitionFile) Add a new common operation policy This operation can be used to add a new common operation policy.
okhttp3.Call	addCommonOperationPolicyAsync(File policySpecFile, File synapsePolicyDefinitionFile, File ccPolicyDefinitionFile, ApiCallback<OperationPolicyDataDTO> _callback) Add a new common operation policy (asynchronously) This operation can be used to add a new common operation policy.
okhttp3.Call	addCommonOperationPolicyCall(File policySpecFile, File synapsePolicyDefinitionFile, File ccPolicyDefinitionFile, ApiCallback _callback) Build call for addCommonOperationPolicy
ApiResponse<OperationPolicyDataDTO>	addCommonOperationPolicyWithHttpInfo(File policySpecFile, File synapsePolicyDefinitionFile, File ccPolicyDefinitionFile) Add a new common operation policy This operation can be used to add a new common operation policy.
void	deleteCommonOperationPolicyByPolicyId(String operationPolicyId) Delete a common operation policy This operation can be used to delete an existing common opreation policy by providing the Id of the policy.
okhttp3.Call	deleteCommonOperationPolicyByPolicyIdAsync(String operationPolicyId, ApiCallback<Void> _callback) Delete a common operation policy (asynchronously) This operation can be used to delete an existing common opreation policy by providing the Id of the policy.
okhttp3.Call	deleteCommonOperationPolicyByPolicyIdCall(String operationPolicyId, ApiCallback _callback) Build call for deleteCommonOperationPolicyByPolicyId
ApiResponse<Void>	deleteCommonOperationPolicyByPolicyIdWithHttpInfo(String operationPolicyId) Delete a common operation policy This operation can be used to delete an existing common opreation policy by providing the Id of the policy.
String	exportOperationPolicySpecificationSchema() Export the operation policies specification schema.
okhttp3.Call	exportOperationPolicySpecificationSchemaAsync(ApiCallback<String> _callback) Export the operation policies specification schema.
okhttp3.Call	exportOperationPolicySpecificationSchemaCall(ApiCallback _callback) Build call for exportOperationPolicySpecificationSchema
ApiResponse<String>	exportOperationPolicySpecificationSchemaWithHttpInfo() Export the operation policies specification schema.
OperationPolicyDataListDTO	getAllCommonOperationPolicies(Integer limit, Integer offset, String query) Get all common operation policies to all the APIs This operation provides you a list of all common operation policies that can be used by any API
okhttp3.Call	getAllCommonOperationPoliciesAsync(Integer limit, Integer offset, String query, ApiCallback<OperationPolicyDataListDTO> _callback) Get all common operation policies to all the APIs (asynchronously) This operation provides you a list of all common operation policies that can be used by any API
okhttp3.Call	getAllCommonOperationPoliciesCall(Integer limit, Integer offset, String query, ApiCallback _callback) Build call for getAllCommonOperationPolicies
ApiResponse<OperationPolicyDataListDTO>	getAllCommonOperationPoliciesWithHttpInfo(Integer limit, Integer offset, String query) Get all common operation policies to all the APIs This operation provides you a list of all common operation policies that can be used by any API
ApiClient	getApiClient()
OperationPolicyDataDTO	getCommonOperationPolicyByPolicyId(String operationPolicyId) Get the details of a common operation policy by providing policy ID This operation can be used to retrieve a particular common operation policy.
okhttp3.Call	getCommonOperationPolicyByPolicyIdAsync(String operationPolicyId, ApiCallback<OperationPolicyDataDTO> _callback) Get the details of a common operation policy by providing policy ID (asynchronously) This operation can be used to retrieve a particular common operation policy.
okhttp3.Call	getCommonOperationPolicyByPolicyIdCall(String operationPolicyId, ApiCallback _callback) Build call for getCommonOperationPolicyByPolicyId
ApiResponse<OperationPolicyDataDTO>	getCommonOperationPolicyByPolicyIdWithHttpInfo(String operationPolicyId) Get the details of a common operation policy by providing policy ID This operation can be used to retrieve a particular common operation policy.
File	getCommonOperationPolicyContentByPolicyId(String operationPolicyId) Download a common operation policy This operation can be used to download a selected common operation policy.
okhttp3.Call	getCommonOperationPolicyContentByPolicyIdAsync(String operationPolicyId, ApiCallback<File> _callback) Download a common operation policy (asynchronously) This operation can be used to download a selected common operation policy.
okhttp3.Call	getCommonOperationPolicyContentByPolicyIdCall(String operationPolicyId, ApiCallback _callback) Build call for getCommonOperationPolicyContentByPolicyId
ApiResponse<File>	getCommonOperationPolicyContentByPolicyIdWithHttpInfo(String operationPolicyId) Download a common operation policy This operation can be used to download a selected common operation 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

OperationPoliciesApi

public OperationPoliciesApi()

OperationPoliciesApi

public OperationPoliciesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

addCommonOperationPolicyCall

public okhttp3.Call addCommonOperationPolicyCall(File policySpecFile,
                                                 File synapsePolicyDefinitionFile,
                                                 File ccPolicyDefinitionFile,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for addCommonOperationPolicy

Parameters:

policySpecFile - Operation policy specification to upload (optional)

synapsePolicyDefinitionFile - Operation policy definition of synapse gateway to upload (optional)

ccPolicyDefinitionFile - Operation policy definition of choreo connect to upload (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

addCommonOperationPolicy

public OperationPolicyDataDTO addCommonOperationPolicy(File policySpecFile,
                                                       File synapsePolicyDefinitionFile,
                                                       File ccPolicyDefinitionFile)
                                                throws ApiException

Add a new common operation policy This operation can be used to add a new common operation policy.

Parameters:

policySpecFile - Operation policy specification to upload (optional)

synapsePolicyDefinitionFile - Operation policy definition of synapse gateway to upload (optional)

ccPolicyDefinitionFile - Operation policy definition of choreo connect to upload (optional)

Returns:

OperationPolicyDataDTO

Throws:

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

addCommonOperationPolicyWithHttpInfo

public ApiResponse<OperationPolicyDataDTO> addCommonOperationPolicyWithHttpInfo(File policySpecFile,
                                                                                File synapsePolicyDefinitionFile,
                                                                                File ccPolicyDefinitionFile)
                                                                         throws ApiException

Add a new common operation policy This operation can be used to add a new common operation policy.

Parameters:

policySpecFile - Operation policy specification to upload (optional)

synapsePolicyDefinitionFile - Operation policy definition of synapse gateway to upload (optional)

ccPolicyDefinitionFile - Operation policy definition of choreo connect to upload (optional)

Returns:

ApiResponse<OperationPolicyDataDTO>

Throws:

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

addCommonOperationPolicyAsync

public okhttp3.Call addCommonOperationPolicyAsync(File policySpecFile,
                                                  File synapsePolicyDefinitionFile,
                                                  File ccPolicyDefinitionFile,
                                                  ApiCallback<OperationPolicyDataDTO> _callback)
                                           throws ApiException

Add a new common operation policy (asynchronously) This operation can be used to add a new common operation policy.

Parameters:

policySpecFile - Operation policy specification to upload (optional)

synapsePolicyDefinitionFile - Operation policy definition of synapse gateway to upload (optional)

ccPolicyDefinitionFile - Operation policy definition of choreo connect to upload (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

deleteCommonOperationPolicyByPolicyIdCall

public okhttp3.Call deleteCommonOperationPolicyByPolicyIdCall(String operationPolicyId,
                                                              ApiCallback _callback)
                                                       throws ApiException

Build call for deleteCommonOperationPolicyByPolicyId

Parameters:

operationPolicyId - Operation policy Id (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCommonOperationPolicyByPolicyId

public void deleteCommonOperationPolicyByPolicyId(String operationPolicyId)
                                           throws ApiException

Delete a common operation policy This operation can be used to delete an existing common opreation policy by providing the Id of the policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Throws:

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

deleteCommonOperationPolicyByPolicyIdWithHttpInfo

public ApiResponse<Void> deleteCommonOperationPolicyByPolicyIdWithHttpInfo(String operationPolicyId)
                                                                    throws ApiException

Delete a common operation policy This operation can be used to delete an existing common opreation policy by providing the Id of the policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCommonOperationPolicyByPolicyIdAsync

public okhttp3.Call deleteCommonOperationPolicyByPolicyIdAsync(String operationPolicyId,
                                                               ApiCallback<Void> _callback)
                                                        throws ApiException

Delete a common operation policy (asynchronously) This operation can be used to delete an existing common opreation policy by providing the Id of the policy.

Parameters:

operationPolicyId - Operation policy Id (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

exportOperationPolicySpecificationSchemaCall

public okhttp3.Call exportOperationPolicySpecificationSchemaCall(ApiCallback _callback)
                                                          throws ApiException

Build call for exportOperationPolicySpecificationSchema

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

exportOperationPolicySpecificationSchema

public String exportOperationPolicySpecificationSchema()
                                                throws ApiException

Export the operation policies specification schema. This operation can be used to export the operation-policy-specification-schema.json used in deployment.

Returns:

String

Throws:

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

exportOperationPolicySpecificationSchemaWithHttpInfo

public ApiResponse<String> exportOperationPolicySpecificationSchemaWithHttpInfo()
                                                                         throws ApiException

Export the operation policies specification schema. This operation can be used to export the operation-policy-specification-schema.json used in deployment.

Returns:

ApiResponse<String>

Throws:

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

exportOperationPolicySpecificationSchemaAsync

public okhttp3.Call exportOperationPolicySpecificationSchemaAsync(ApiCallback<String> _callback)
                                                           throws ApiException

Export the operation policies specification schema. (asynchronously) This operation can be used to export the operation-policy-specification-schema.json used in deployment.

Parameters:

_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

getAllCommonOperationPoliciesCall

public okhttp3.Call getAllCommonOperationPoliciesCall(Integer limit,
                                                      Integer offset,
                                                      String query,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for getAllCommonOperationPolicies

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - -Not supported yet- (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllCommonOperationPolicies

public OperationPolicyDataListDTO getAllCommonOperationPolicies(Integer limit,
                                                                Integer offset,
                                                                String query)
                                                         throws ApiException

Get all common operation policies to all the APIs This operation provides you a list of all common operation policies that can be used by any API

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - -Not supported yet- (optional)

Returns:

OperationPolicyDataListDTO

Throws:

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

getAllCommonOperationPoliciesWithHttpInfo

public ApiResponse<OperationPolicyDataListDTO> getAllCommonOperationPoliciesWithHttpInfo(Integer limit,
                                                                                         Integer offset,
                                                                                         String query)
                                                                                  throws ApiException

Get all common operation policies to all the APIs This operation provides you a list of all common operation policies that can be used by any API

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - -Not supported yet- (optional)

Returns:

ApiResponse<OperationPolicyDataListDTO>

Throws:

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

getAllCommonOperationPoliciesAsync

public okhttp3.Call getAllCommonOperationPoliciesAsync(Integer limit,
                                                       Integer offset,
                                                       String query,
                                                       ApiCallback<OperationPolicyDataListDTO> _callback)
                                                throws ApiException

Get all common operation policies to all the APIs (asynchronously) This operation provides you a list of all common operation policies that can be used by any API

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - -Not supported yet- (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

getCommonOperationPolicyByPolicyIdCall

public okhttp3.Call getCommonOperationPolicyByPolicyIdCall(String operationPolicyId,
                                                           ApiCallback _callback)
                                                    throws ApiException

Build call for getCommonOperationPolicyByPolicyId

Parameters:

operationPolicyId - Operation policy Id (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCommonOperationPolicyByPolicyId

public OperationPolicyDataDTO getCommonOperationPolicyByPolicyId(String operationPolicyId)
                                                          throws ApiException

Get the details of a common operation policy by providing policy ID This operation can be used to retrieve a particular common operation policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Returns:

OperationPolicyDataDTO

Throws:

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

getCommonOperationPolicyByPolicyIdWithHttpInfo

public ApiResponse<OperationPolicyDataDTO> getCommonOperationPolicyByPolicyIdWithHttpInfo(String operationPolicyId)
                                                                                   throws ApiException

Get the details of a common operation policy by providing policy ID This operation can be used to retrieve a particular common operation policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Returns:

ApiResponse<OperationPolicyDataDTO>

Throws:

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

getCommonOperationPolicyByPolicyIdAsync

public okhttp3.Call getCommonOperationPolicyByPolicyIdAsync(String operationPolicyId,
                                                            ApiCallback<OperationPolicyDataDTO> _callback)
                                                     throws ApiException

Get the details of a common operation policy by providing policy ID (asynchronously) This operation can be used to retrieve a particular common operation policy.

Parameters:

operationPolicyId - Operation policy Id (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

getCommonOperationPolicyContentByPolicyIdCall

public okhttp3.Call getCommonOperationPolicyContentByPolicyIdCall(String operationPolicyId,
                                                                  ApiCallback _callback)
                                                           throws ApiException

Build call for getCommonOperationPolicyContentByPolicyId

Parameters:

operationPolicyId - Operation policy Id (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCommonOperationPolicyContentByPolicyId

public File getCommonOperationPolicyContentByPolicyId(String operationPolicyId)
                                               throws ApiException

Download a common operation policy This operation can be used to download a selected common operation policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Returns:

File

Throws:

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

getCommonOperationPolicyContentByPolicyIdWithHttpInfo

public ApiResponse<File> getCommonOperationPolicyContentByPolicyIdWithHttpInfo(String operationPolicyId)
                                                                        throws ApiException

Download a common operation policy This operation can be used to download a selected common operation policy.

Parameters:

operationPolicyId - Operation policy Id (required)

Returns:

ApiResponse<File>

Throws:

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

getCommonOperationPolicyContentByPolicyIdAsync

public okhttp3.Call getCommonOperationPolicyContentByPolicyIdAsync(String operationPolicyId,
                                                                   ApiCallback<File> _callback)
                                                            throws ApiException

Download a common operation policy (asynchronously) This operation can be used to download a selected common operation policy.

Parameters:

operationPolicyId - Operation policy Id (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