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

Class GovernancePoliciesApi

  • public class GovernancePoliciesApi
extends Object

    • Constructor Detail

      • GovernancePoliciesApi

        public GovernancePoliciesApi()

      • GovernancePoliciesApi

        public GovernancePoliciesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createGovernancePolicyCall

        public okhttp3.Call createGovernancePolicyCall​(APIMGovernancePolicyDTO apIMGovernancePolicyDTO,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for createGovernancePolicy
        Parameters:
        apIMGovernancePolicyDTO - JSON object containing the details of the new governance policy. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createGovernancePolicy

        public APIMGovernancePolicyDTO createGovernancePolicy​(APIMGovernancePolicyDTO apIMGovernancePolicyDTO)
                                               throws ApiException
        Creates a new governance policy. Creates a new governance policy for the user's organization.
        Parameters:
        apIMGovernancePolicyDTO - JSON object containing the details of the new governance policy. (required)
        Returns:
        APIMGovernancePolicyDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGovernancePolicyWithHttpInfo

        public ApiResponse<APIMGovernancePolicyDTO> createGovernancePolicyWithHttpInfo​(APIMGovernancePolicyDTO apIMGovernancePolicyDTO)
                                                                        throws ApiException
        Creates a new governance policy. Creates a new governance policy for the user's organization.
        Parameters:
        apIMGovernancePolicyDTO - JSON object containing the details of the new governance policy. (required)
        Returns:
        ApiResponse<APIMGovernancePolicyDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGovernancePolicyAsync

        public okhttp3.Call createGovernancePolicyAsync​(APIMGovernancePolicyDTO apIMGovernancePolicyDTO,
                                                ApiCallback<APIMGovernancePolicyDTO> _callback)
                                         throws ApiException
        Creates a new governance policy. (asynchronously) Creates a new governance policy for the user's organization.
        Parameters:
        apIMGovernancePolicyDTO - JSON object containing the details of the new governance policy. (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

      • deleteGovernancePolicyCall

        public okhttp3.Call deleteGovernancePolicyCall​(String policyId,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for deleteGovernancePolicy
        Parameters:
        policyId - **UUID** of the Policy. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteGovernancePolicy

        public void deleteGovernancePolicy​(String policyId)
                            throws ApiException
        Delete a specific governance policy Deletes an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGovernancePolicyWithHttpInfo

        public ApiResponse<Void> deleteGovernancePolicyWithHttpInfo​(String policyId)
                                                     throws ApiException
        Delete a specific governance policy Deletes an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGovernancePolicyAsync

        public okhttp3.Call deleteGovernancePolicyAsync​(String policyId,
                                                ApiCallback<Void> _callback)
                                         throws ApiException
        Delete a specific governance policy (asynchronously) Deletes an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (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

      • getGovernancePoliciesCall

        public okhttp3.Call getGovernancePoliciesCall​(Integer limit,
                                              Integer offset,
                                              String query,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for getGovernancePolicies
        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 - You can search for governance policies using following format. - \"query=name:{NAME}\" searches policies by name. - \"query=state:{STATE} \" searches policies by state. You can also use multiple attributes to search for policies. - \"query=name:{NAME} state:{STATE}\" searches policies by name, state, and label. Remember to use URL encoding if your client doesn't support it (e.g., curl). (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getGovernancePolicies

        public APIMGovernancePolicyListDTO getGovernancePolicies​(Integer limit,
                                                         Integer offset,
                                                         String query)
                                                  throws ApiException
        Retrieves a list of all governance policies. Retrieves a list of governance policies for the user's organization.
        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 - You can search for governance policies using following format. - \"query=name:{NAME}\" searches policies by name. - \"query=state:{STATE} \" searches policies by state. You can also use multiple attributes to search for policies. - \"query=name:{NAME} state:{STATE}\" searches policies by name, state, and label. Remember to use URL encoding if your client doesn't support it (e.g., curl). (optional)
        Returns:
        APIMGovernancePolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGovernancePoliciesWithHttpInfo

        public ApiResponse<APIMGovernancePolicyListDTO> getGovernancePoliciesWithHttpInfo​(Integer limit,
                                                                                  Integer offset,
                                                                                  String query)
                                                                           throws ApiException
        Retrieves a list of all governance policies. Retrieves a list of governance policies for the user's organization.
        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 - You can search for governance policies using following format. - \"query=name:{NAME}\" searches policies by name. - \"query=state:{STATE} \" searches policies by state. You can also use multiple attributes to search for policies. - \"query=name:{NAME} state:{STATE}\" searches policies by name, state, and label. Remember to use URL encoding if your client doesn't support it (e.g., curl). (optional)
        Returns:
        ApiResponse<APIMGovernancePolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGovernancePoliciesAsync

        public okhttp3.Call getGovernancePoliciesAsync​(Integer limit,
                                               Integer offset,
                                               String query,
                                               ApiCallback<APIMGovernancePolicyListDTO> _callback)
                                        throws ApiException
        Retrieves a list of all governance policies. (asynchronously) Retrieves a list of governance policies for the user's organization.
        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 - You can search for governance policies using following format. - \"query=name:{NAME}\" searches policies by name. - \"query=state:{STATE} \" searches policies by state. You can also use multiple attributes to search for policies. - \"query=name:{NAME} state:{STATE}\" searches policies by name, state, and label. Remember to use URL encoding if your client doesn't support it (e.g., 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

      • getGovernancePolicyByIdCall

        public okhttp3.Call getGovernancePolicyByIdCall​(String policyId,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getGovernancePolicyById
        Parameters:
        policyId - **UUID** of the Policy. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getGovernancePolicyById

        public APIMGovernancePolicyDTO getGovernancePolicyById​(String policyId)
                                                throws ApiException
        Get a specific governance policy Retrieves details of a specific governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        Returns:
        APIMGovernancePolicyDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGovernancePolicyByIdWithHttpInfo

        public ApiResponse<APIMGovernancePolicyDTO> getGovernancePolicyByIdWithHttpInfo​(String policyId)
                                                                         throws ApiException
        Get a specific governance policy Retrieves details of a specific governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        Returns:
        ApiResponse<APIMGovernancePolicyDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGovernancePolicyByIdAsync

        public okhttp3.Call getGovernancePolicyByIdAsync​(String policyId,
                                                 ApiCallback<APIMGovernancePolicyDTO> _callback)
                                          throws ApiException
        Get a specific governance policy (asynchronously) Retrieves details of a specific governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (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

      • updateGovernancePolicyByIdCall

        public okhttp3.Call updateGovernancePolicyByIdCall​(String policyId,
                                                   APIMGovernancePolicyDTO apIMGovernancePolicyDTO,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for updateGovernancePolicyById
        Parameters:
        policyId - **UUID** of the Policy. (required)
        apIMGovernancePolicyDTO - JSON object containing the updated governance policy details. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateGovernancePolicyById

        public APIMGovernancePolicyDTO updateGovernancePolicyById​(String policyId,
                                                          APIMGovernancePolicyDTO apIMGovernancePolicyDTO)
                                                   throws ApiException
        Update a specific governance policy Updates the details of an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        apIMGovernancePolicyDTO - JSON object containing the updated governance policy details. (required)
        Returns:
        APIMGovernancePolicyDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateGovernancePolicyByIdWithHttpInfo

        public ApiResponse<APIMGovernancePolicyDTO> updateGovernancePolicyByIdWithHttpInfo​(String policyId,
                                                                                   APIMGovernancePolicyDTO apIMGovernancePolicyDTO)
                                                                            throws ApiException
        Update a specific governance policy Updates the details of an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        apIMGovernancePolicyDTO - JSON object containing the updated governance policy details. (required)
        Returns:
        ApiResponse<APIMGovernancePolicyDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateGovernancePolicyByIdAsync

        public okhttp3.Call updateGovernancePolicyByIdAsync​(String policyId,
                                                    APIMGovernancePolicyDTO apIMGovernancePolicyDTO,
                                                    ApiCallback<APIMGovernancePolicyDTO> _callback)
                                             throws ApiException
        Update a specific governance policy (asynchronously) Updates the details of an existing governance policy identified by the policyId.
        Parameters:
        policyId - **UUID** of the Policy. (required)
        apIMGovernancePolicyDTO - JSON object containing the updated governance policy details. (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