Package 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 Details

    • OperationPoliciesApi

      public OperationPoliciesApi()

    • OperationPoliciesApi

      public OperationPoliciesApi(ApiClient apiClient)

  • Method Details

    • 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

    • getAllCommonOperationPoliciesCall

      public okhttp3.Call getAllCommonOperationPoliciesCall(Integer limit, Integer offset, String query, ApiCallback _callback) throws ApiException
      Build call for getAllCommonOperationPolicies
      Parameters:
      limit - Maximum size of policy array to return. (optional)
      offset - Starting point within the complete list of items qualified. (optional, default to 0)
      query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"name:addHeader\" will match an API Policy if the provider of the API Policy contains \"addHeader\". \"version:\"v1\"\" will match an API Policy if the provider of the API Policy contains \"v1\". Also you can use combined modifiers Eg. name:addHeader&version:v1 will match an API Policy if the name of the API Policy is addHeader and version is v1. Supported attribute modifiers are [**version, name**] If query attributes are provided, this returns all API policies available under the given limit. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (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 policy array to return. (optional)
      offset - Starting point within the complete list of items qualified. (optional, default to 0)
      query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"name:addHeader\" will match an API Policy if the provider of the API Policy contains \"addHeader\". \"version:\"v1\"\" will match an API Policy if the provider of the API Policy contains \"v1\". Also you can use combined modifiers Eg. name:addHeader&version:v1 will match an API Policy if the name of the API Policy is addHeader and version is v1. Supported attribute modifiers are [**version, name**] If query attributes are provided, this returns all API policies available under the given limit. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (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 policy array to return. (optional)
      offset - Starting point within the complete list of items qualified. (optional, default to 0)
      query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"name:addHeader\" will match an API Policy if the provider of the API Policy contains \"addHeader\". \"version:\"v1\"\" will match an API Policy if the provider of the API Policy contains \"v1\". Also you can use combined modifiers Eg. name:addHeader&version:v1 will match an API Policy if the name of the API Policy is addHeader and version is v1. Supported attribute modifiers are [**version, name**] If query attributes are provided, this returns all API policies available under the given limit. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (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 policy array to return. (optional)
      offset - Starting point within the complete list of items qualified. (optional, default to 0)
      query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"name:addHeader\" will match an API Policy if the provider of the API Policy contains \"addHeader\". \"version:\"v1\"\" will match an API Policy if the provider of the API Policy contains \"v1\". Also you can use combined modifiers Eg. name:addHeader&version:v1 will match an API Policy if the name of the API Policy is addHeader and version is v1. Supported attribute modifiers are [**version, name**] If query attributes are provided, this returns all API policies available under the given limit. Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) (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