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

Class GatewayPoliciesApi

java.lang.Object
org.wso2.am.integration.clients.publisher.api.v1.GatewayPoliciesApi
public class GatewayPoliciesApi extends Object

  • Constructor Details

    • GatewayPoliciesApi

      public GatewayPoliciesApi()

    • GatewayPoliciesApi

      public GatewayPoliciesApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • addGatewayPoliciesToFlowsCall

      public okhttp3.Call addGatewayPoliciesToFlowsCall(GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO, ApiCallback _callback) throws ApiException
      Build call for addGatewayPoliciesToFlows
      Parameters:
      gatewayPolicyMappingsDTO - Policy details object that needs to be added. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • addGatewayPoliciesToFlows

      public GatewayPolicyMappingInfoDTO addGatewayPoliciesToFlows(GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO) throws ApiException
      Engage gateway policies to the request, response, fault flows This operation can be used to apply gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingsDTO - Policy details object that needs to be added. (required)
      Returns:
      GatewayPolicyMappingInfoDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • addGatewayPoliciesToFlowsWithHttpInfo

      public ApiResponse<GatewayPolicyMappingInfoDTO> addGatewayPoliciesToFlowsWithHttpInfo(GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO) throws ApiException
      Engage gateway policies to the request, response, fault flows This operation can be used to apply gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingsDTO - Policy details object that needs to be added. (required)
      Returns:
      ApiResponse<GatewayPolicyMappingInfoDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • addGatewayPoliciesToFlowsAsync

      public okhttp3.Call addGatewayPoliciesToFlowsAsync(GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO, ApiCallback<GatewayPolicyMappingInfoDTO> _callback) throws ApiException
      Engage gateway policies to the request, response, fault flows (asynchronously) This operation can be used to apply gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingsDTO - Policy details object that needs to be added. (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

    • deleteGatewayPolicyByPolicyIdCall

      public okhttp3.Call deleteGatewayPolicyByPolicyIdCall(String gatewayPolicyMappingId, ApiCallback _callback) throws ApiException
      Build call for deleteGatewayPolicyByPolicyId
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteGatewayPolicyByPolicyId

      public void deleteGatewayPolicyByPolicyId(String gatewayPolicyMappingId) throws ApiException
      Delete a gateway policy mapping This operation can be used to delete an existing gateway policy mapping by providing the Id of the policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteGatewayPolicyByPolicyIdWithHttpInfo

      public ApiResponse<Void> deleteGatewayPolicyByPolicyIdWithHttpInfo(String gatewayPolicyMappingId) throws ApiException
      Delete a gateway policy mapping This operation can be used to delete an existing gateway policy mapping by providing the Id of the policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteGatewayPolicyByPolicyIdAsync

      public okhttp3.Call deleteGatewayPolicyByPolicyIdAsync(String gatewayPolicyMappingId, ApiCallback<Void> _callback) throws ApiException
      Delete a gateway policy mapping (asynchronously) This operation can be used to delete an existing gateway policy mapping by providing the Id of the policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping 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

    • engageGlobalPolicyCall

      public okhttp3.Call engageGlobalPolicyCall(String gatewayPolicyMappingId, List<GatewayPolicyDeploymentDTO> gatewayPolicyDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for engageGlobalPolicy
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyDeploymentDTO - Policy details object that needs to be added. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • engageGlobalPolicy

      public List<GatewayPolicyDeploymentDTO> engageGlobalPolicy(String gatewayPolicyMappingId, List<GatewayPolicyDeploymentDTO> gatewayPolicyDeploymentDTO) throws ApiException
      Engage gateway policy mapping to the gateways This operation can be used to engage gateway policy mapping to the gateway/s.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyDeploymentDTO - Policy details object that needs to be added. (required)
      Returns:
      List<GatewayPolicyDeploymentDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • engageGlobalPolicyWithHttpInfo

      public ApiResponse<List<GatewayPolicyDeploymentDTO>> engageGlobalPolicyWithHttpInfo(String gatewayPolicyMappingId, List<GatewayPolicyDeploymentDTO> gatewayPolicyDeploymentDTO) throws ApiException
      Engage gateway policy mapping to the gateways This operation can be used to engage gateway policy mapping to the gateway/s.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyDeploymentDTO - Policy details object that needs to be added. (required)
      Returns:
      ApiResponse<List<GatewayPolicyDeploymentDTO>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • engageGlobalPolicyAsync

      public okhttp3.Call engageGlobalPolicyAsync(String gatewayPolicyMappingId, List<GatewayPolicyDeploymentDTO> gatewayPolicyDeploymentDTO, ApiCallback<List<GatewayPolicyDeploymentDTO>> _callback) throws ApiException
      Engage gateway policy mapping to the gateways (asynchronously) This operation can be used to engage gateway policy mapping to the gateway/s.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyDeploymentDTO - Policy details object that needs to be added. (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

    • getAllGatewayPoliciesCall

      public okhttp3.Call getAllGatewayPoliciesCall(Integer limit, Integer offset, String query, ApiCallback _callback) throws ApiException
      Build call for getAllGatewayPolicies
      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 **\"gatewayLabel:\"** modifier. Eg. The entry \"gatewayLabel:gateway1\" will result in a match with a Gateway Policy Mapping only if the policy mapping is deployed on \"gateway1\". If query attribute is provided, this returns the Gateway policy Mapping 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

    • getAllGatewayPolicies

      public GatewayPolicyMappingDataListDTO getAllGatewayPolicies(Integer limit, Integer offset, String query) throws ApiException
      Get all gateway policies mapping information This operation provides you a list of all gateway policies mapping information.
      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 **\"gatewayLabel:\"** modifier. Eg. The entry \"gatewayLabel:gateway1\" will result in a match with a Gateway Policy Mapping only if the policy mapping is deployed on \"gateway1\". If query attribute is provided, this returns the Gateway policy Mapping 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:
      GatewayPolicyMappingDataListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAllGatewayPoliciesWithHttpInfo

      public ApiResponse<GatewayPolicyMappingDataListDTO> getAllGatewayPoliciesWithHttpInfo(Integer limit, Integer offset, String query) throws ApiException
      Get all gateway policies mapping information This operation provides you a list of all gateway policies mapping information.
      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 **\"gatewayLabel:\"** modifier. Eg. The entry \"gatewayLabel:gateway1\" will result in a match with a Gateway Policy Mapping only if the policy mapping is deployed on \"gateway1\". If query attribute is provided, this returns the Gateway policy Mapping 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<GatewayPolicyMappingDataListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAllGatewayPoliciesAsync

      public okhttp3.Call getAllGatewayPoliciesAsync(Integer limit, Integer offset, String query, ApiCallback<GatewayPolicyMappingDataListDTO> _callback) throws ApiException
      Get all gateway policies mapping information (asynchronously) This operation provides you a list of all gateway policies mapping information.
      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 **\"gatewayLabel:\"** modifier. Eg. The entry \"gatewayLabel:gateway1\" will result in a match with a Gateway Policy Mapping only if the policy mapping is deployed on \"gateway1\". If query attribute is provided, this returns the Gateway policy Mapping 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

    • getGatewayPolicyMappingContentByPolicyMappingIdCall

      public okhttp3.Call getGatewayPolicyMappingContentByPolicyMappingIdCall(String gatewayPolicyMappingId, ApiCallback _callback) throws ApiException
      Build call for getGatewayPolicyMappingContentByPolicyMappingId
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getGatewayPolicyMappingContentByPolicyMappingId

      public GatewayPolicyMappingsDTO getGatewayPolicyMappingContentByPolicyMappingId(String gatewayPolicyMappingId) throws ApiException
      Retrieve information of a selected gateway policy mapping This operation can be used to retrieve information of a selected gateway policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      Returns:
      GatewayPolicyMappingsDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getGatewayPolicyMappingContentByPolicyMappingIdWithHttpInfo

      public ApiResponse<GatewayPolicyMappingsDTO> getGatewayPolicyMappingContentByPolicyMappingIdWithHttpInfo(String gatewayPolicyMappingId) throws ApiException
      Retrieve information of a selected gateway policy mapping This operation can be used to retrieve information of a selected gateway policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      Returns:
      ApiResponse<GatewayPolicyMappingsDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getGatewayPolicyMappingContentByPolicyMappingIdAsync

      public okhttp3.Call getGatewayPolicyMappingContentByPolicyMappingIdAsync(String gatewayPolicyMappingId, ApiCallback<GatewayPolicyMappingsDTO> _callback) throws ApiException
      Retrieve information of a selected gateway policy mapping (asynchronously) This operation can be used to retrieve information of a selected gateway policy mapping.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping 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

    • updateGatewayPoliciesToFlowsCall

      public okhttp3.Call updateGatewayPoliciesToFlowsCall(String gatewayPolicyMappingId, GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO, ApiCallback _callback) throws ApiException
      Build call for updateGatewayPoliciesToFlows
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyMappingsDTO - Policy details object that needs to be updated. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateGatewayPoliciesToFlows

      public GatewayPolicyMappingsDTO updateGatewayPoliciesToFlows(String gatewayPolicyMappingId, GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO) throws ApiException
      Update gateway policies added to the request, response, fault flows This operation can be used to update already added gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyMappingsDTO - Policy details object that needs to be updated. (required)
      Returns:
      GatewayPolicyMappingsDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateGatewayPoliciesToFlowsWithHttpInfo

      public ApiResponse<GatewayPolicyMappingsDTO> updateGatewayPoliciesToFlowsWithHttpInfo(String gatewayPolicyMappingId, GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO) throws ApiException
      Update gateway policies added to the request, response, fault flows This operation can be used to update already added gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyMappingsDTO - Policy details object that needs to be updated. (required)
      Returns:
      ApiResponse<GatewayPolicyMappingsDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateGatewayPoliciesToFlowsAsync

      public okhttp3.Call updateGatewayPoliciesToFlowsAsync(String gatewayPolicyMappingId, GatewayPolicyMappingsDTO gatewayPolicyMappingsDTO, ApiCallback<GatewayPolicyMappingsDTO> _callback) throws ApiException
      Update gateway policies added to the request, response, fault flows (asynchronously) This operation can be used to update already added gateway policies to the request, response, fault flows.
      Parameters:
      gatewayPolicyMappingId - Gateway policy mapping Id (required)
      gatewayPolicyMappingsDTO - Policy details object that needs to be updated. (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