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

Class ApiOperationPoliciesApi

  • public class ApiOperationPoliciesApi
extends Object

    • Constructor Detail

      • ApiOperationPoliciesApi

        public ApiOperationPoliciesApi()

      • ApiOperationPoliciesApi

        public ApiOperationPoliciesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • addAPISpecificOperationPolicyCall

        public okhttp3.Call addAPISpecificOperationPolicyCall​(String apiId,
                                                      File policySpecFile,
                                                      File synapsePolicyDefinitionFile,
                                                      File ccPolicyDefinitionFile,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for addAPISpecificOperationPolicy
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        policySpecFile - 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

      • addAPISpecificOperationPolicy

        public OperationPolicyDataDTO addAPISpecificOperationPolicy​(String apiId,
                                                            File policySpecFile,
                                                            File synapsePolicyDefinitionFile,
                                                            File ccPolicyDefinitionFile)
                                                     throws ApiException
        Add an API specific operation policy This operation can be used to add an API specifc operation policy. This policy cannot be used in other APIs.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        policySpecFile - 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

      • addAPISpecificOperationPolicyWithHttpInfo

        public ApiResponse<OperationPolicyDataDTO> addAPISpecificOperationPolicyWithHttpInfo​(String apiId,
                                                                                     File policySpecFile,
                                                                                     File synapsePolicyDefinitionFile,
                                                                                     File ccPolicyDefinitionFile)
                                                                              throws ApiException
        Add an API specific operation policy This operation can be used to add an API specifc operation policy. This policy cannot be used in other APIs.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        policySpecFile - 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

      • addAPISpecificOperationPolicyAsync

        public okhttp3.Call addAPISpecificOperationPolicyAsync​(String apiId,
                                                       File policySpecFile,
                                                       File synapsePolicyDefinitionFile,
                                                       File ccPolicyDefinitionFile,
                                                       ApiCallback<OperationPolicyDataDTO> _callback)
                                                throws ApiException
        Add an API specific operation policy (asynchronously) This operation can be used to add an API specifc operation policy. This policy cannot be used in other APIs.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        policySpecFile - 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

      • deleteAPISpecificOperationPolicyByPolicyIdCall

        public okhttp3.Call deleteAPISpecificOperationPolicyByPolicyIdCall​(String apiId,
                                                                   String operationPolicyId,
                                                                   ApiCallback _callback)
                                                            throws ApiException
        Build call for deleteAPISpecificOperationPolicyByPolicyId
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • deleteAPISpecificOperationPolicyByPolicyId

        public void deleteAPISpecificOperationPolicyByPolicyId​(String apiId,
                                                       String operationPolicyId)
                                                throws ApiException
        Delete an API Specific Operation Policy This operation can be used to delete an existing API specific opreation policy by providing the Id of the API and the Id of the policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        operationPolicyId - Operation policy Id (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteAPISpecificOperationPolicyByPolicyIdWithHttpInfo

        public ApiResponse<Void> deleteAPISpecificOperationPolicyByPolicyIdWithHttpInfo​(String apiId,
                                                                                String operationPolicyId)
                                                                         throws ApiException
        Delete an API Specific Operation Policy This operation can be used to delete an existing API specific opreation policy by providing the Id of the API and the Id of the policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • deleteAPISpecificOperationPolicyByPolicyIdAsync

        public okhttp3.Call deleteAPISpecificOperationPolicyByPolicyIdAsync​(String apiId,
                                                                    String operationPolicyId,
                                                                    ApiCallback<Void> _callback)
                                                             throws ApiException
        Delete an API Specific Operation Policy (asynchronously) This operation can be used to delete an existing API specific opreation policy by providing the Id of the API and the Id of the policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAPISpecificOperationPolicyContentByPolicyIdCall

        public okhttp3.Call getAPISpecificOperationPolicyContentByPolicyIdCall​(String apiId,
                                                                       String operationPolicyId,
                                                                       ApiCallback _callback)
                                                                throws ApiException
        Build call for getAPISpecificOperationPolicyContentByPolicyId
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAPISpecificOperationPolicyContentByPolicyId

        public File getAPISpecificOperationPolicyContentByPolicyId​(String apiId,
                                                           String operationPolicyId)
                                                    throws ApiException
        Download an API Specific Operation Policy This operation can be used to download a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAPISpecificOperationPolicyContentByPolicyIdWithHttpInfo

        public ApiResponse<File> getAPISpecificOperationPolicyContentByPolicyIdWithHttpInfo​(String apiId,
                                                                                    String operationPolicyId)
                                                                             throws ApiException
        Download an API Specific Operation Policy This operation can be used to download a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAPISpecificOperationPolicyContentByPolicyIdAsync

        public okhttp3.Call getAPISpecificOperationPolicyContentByPolicyIdAsync​(String apiId,
                                                                        String operationPolicyId,
                                                                        ApiCallback<File> _callback)
                                                                 throws ApiException
        Download an API Specific Operation Policy (asynchronously) This operation can be used to download a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAllAPISpecificOperationPoliciesCall

        public okhttp3.Call getAllAPISpecificOperationPoliciesCall​(String apiId,
                                                           Integer limit,
                                                           Integer offset,
                                                           String query,
                                                           ApiCallback _callback)
                                                    throws ApiException
        Build call for getAllAPISpecificOperationPolicies
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAllAPISpecificOperationPolicies

        public OperationPolicyDataListDTO getAllAPISpecificOperationPolicies​(String apiId,
                                                                     Integer limit,
                                                                     Integer offset,
                                                                     String query)
                                                              throws ApiException
        Get all API specific operation policies for an API This operation provides you a list of all applicabale operation policies for an API
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAllAPISpecificOperationPoliciesWithHttpInfo

        public ApiResponse<OperationPolicyDataListDTO> getAllAPISpecificOperationPoliciesWithHttpInfo​(String apiId,
                                                                                              Integer limit,
                                                                                              Integer offset,
                                                                                              String query)
                                                                                       throws ApiException
        Get all API specific operation policies for an API This operation provides you a list of all applicabale operation policies for an API
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getAllAPISpecificOperationPoliciesAsync

        public okhttp3.Call getAllAPISpecificOperationPoliciesAsync​(String apiId,
                                                            Integer limit,
                                                            Integer offset,
                                                            String query,
                                                            ApiCallback<OperationPolicyDataListDTO> _callback)
                                                     throws ApiException
        Get all API specific operation policies for an API (asynchronously) This operation provides you a list of all applicabale operation policies for an API
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getOperationPolicyForAPIByPolicyIdCall

        public okhttp3.Call getOperationPolicyForAPIByPolicyIdCall​(String apiId,
                                                           String operationPolicyId,
                                                           ApiCallback _callback)
                                                    throws ApiException
        Build call for getOperationPolicyForAPIByPolicyId
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getOperationPolicyForAPIByPolicyId

        public OperationPolicyDataDTO getOperationPolicyForAPIByPolicyId​(String apiId,
                                                                 String operationPolicyId)
                                                          throws ApiException
        Get policy details of an API specific policy This operation can be used to retrieve a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getOperationPolicyForAPIByPolicyIdWithHttpInfo

        public ApiResponse<OperationPolicyDataDTO> getOperationPolicyForAPIByPolicyIdWithHttpInfo​(String apiId,
                                                                                          String operationPolicyId)
                                                                                   throws ApiException
        Get policy details of an API specific policy This operation can be used to retrieve a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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

      • getOperationPolicyForAPIByPolicyIdAsync

        public okhttp3.Call getOperationPolicyForAPIByPolicyIdAsync​(String apiId,
                                                            String operationPolicyId,
                                                            ApiCallback<OperationPolicyDataDTO> _callback)
                                                     throws ApiException
        Get policy details of an API specific policy (asynchronously) This operation can be used to retrieve a particular API specific operation policy.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        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