Package org.wso2.am.integration.clients.gateway.api.v2

Class DefaultApi

  • public class DefaultApi
extends Object

    • Constructor Detail

      • DefaultApi

        public DefaultApi()

      • DefaultApi

        public DefaultApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getAPIArtifactsCall

        public com.squareup.okhttp.Call getAPIArtifactsCall​(String apiName,
                                                    String version,
                                                    String tenantDomain,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException
        Build call for getAPIArtifacts
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getAPIArtifacts

        public APIArtifactDTO getAPIArtifacts​(String apiName,
                                      String version,
                                      String tenantDomain)
                               throws ApiException
        Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        APIArtifactDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAPIArtifactsWithHttpInfo

        public ApiResponse<APIArtifactDTO> getAPIArtifactsWithHttpInfo​(String apiName,
                                                               String version,
                                                               String tenantDomain)
                                                        throws ApiException
        Get API artifact from the storage This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<APIArtifactDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAPIArtifactsAsync

        public com.squareup.okhttp.Call getAPIArtifactsAsync​(String apiName,
                                                     String version,
                                                     String tenantDomain,
                                                     ApiCallback<APIArtifactDTO> callback)
                                              throws ApiException
        Get API artifact from the storage (asynchronously) This operation is used to get the local entries, sequences and endpoints from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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

      • getEndpointsCall

        public com.squareup.okhttp.Call getEndpointsCall​(String apiName,
                                                 String version,
                                                 String tenantDomain,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException
        Build call for getEndpoints
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEndpoints

        public EndpointsDTO getEndpoints​(String apiName,
                                 String version,
                                 String tenantDomain)
                          throws ApiException
        Get end-points from the storage for the API This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        EndpointsDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointsWithHttpInfo

        public ApiResponse<EndpointsDTO> getEndpointsWithHttpInfo​(String apiName,
                                                          String version,
                                                          String tenantDomain)
                                                   throws ApiException
        Get end-points from the storage for the API This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<EndpointsDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEndpointsAsync

        public com.squareup.okhttp.Call getEndpointsAsync​(String apiName,
                                                  String version,
                                                  String tenantDomain,
                                                  ApiCallback<EndpointsDTO> callback)
                                           throws ApiException
        Get end-points from the storage for the API (asynchronously) This operation is used to get the end-points from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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

      • getLocalEntriesCall

        public com.squareup.okhttp.Call getLocalEntriesCall​(String apiName,
                                                    String version,
                                                    String tenantDomain,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException
        Build call for getLocalEntries
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getLocalEntries

        public LocalEntryDTO getLocalEntries​(String apiName,
                                     String version,
                                     String tenantDomain)
                              throws ApiException
        Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        LocalEntryDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalEntriesWithHttpInfo

        public ApiResponse<LocalEntryDTO> getLocalEntriesWithHttpInfo​(String apiName,
                                                              String version,
                                                              String tenantDomain)
                                                       throws ApiException
        Get Local Entry from the storage This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<LocalEntryDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalEntriesAsync

        public com.squareup.okhttp.Call getLocalEntriesAsync​(String apiName,
                                                     String version,
                                                     String tenantDomain,
                                                     ApiCallback<LocalEntryDTO> callback)
                                              throws ApiException
        Get Local Entry from the storage (asynchronously) This operation is used to get local entry from the storage.If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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

      • getSequencesCall

        public com.squareup.okhttp.Call getSequencesCall​(String apiName,
                                                 String version,
                                                 String tenantDomain,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException
        Build call for getSequences
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getSequences

        public SequencesDTO getSequences​(String apiName,
                                 String version,
                                 String tenantDomain)
                          throws ApiException
        Get sequences from the storage This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        SequencesDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSequencesWithHttpInfo

        public ApiResponse<SequencesDTO> getSequencesWithHttpInfo​(String apiName,
                                                          String version,
                                                          String tenantDomain)
                                                   throws ApiException
        Get sequences from the storage This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<SequencesDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSequencesAsync

        public com.squareup.okhttp.Call getSequencesAsync​(String apiName,
                                                  String version,
                                                  String tenantDomain,
                                                  ApiCallback<SequencesDTO> callback)
                                           throws ApiException
        Get sequences from the storage (asynchronously) This operation is used to get the API sequence from the storage. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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

      • redployAPICall

        public com.squareup.okhttp.Call redployAPICall​(String apiName,
                                               String version,
                                               String tenantDomain,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException
        Build call for redployAPI
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • redployAPI

        public DeployResponseDTO redployAPI​(String apiName,
                                    String version,
                                    String tenantDomain)
                             throws ApiException
        Re Deploy the API in the gateway This operation is used to re deploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        DeployResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • redployAPIWithHttpInfo

        public ApiResponse<DeployResponseDTO> redployAPIWithHttpInfo​(String apiName,
                                                             String version,
                                                             String tenantDomain)
                                                      throws ApiException
        Re Deploy the API in the gateway This operation is used to re deploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<DeployResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • redployAPIAsync

        public com.squareup.okhttp.Call redployAPIAsync​(String apiName,
                                                String version,
                                                String tenantDomain,
                                                ApiCallback<DeployResponseDTO> callback)
                                         throws ApiException
        Re Deploy the API in the gateway (asynchronously) This operation is used to re deploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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

      • serverStartupHealthcheckGet

        public void serverStartupHealthcheckGet()
                                 throws ApiException
        Health check to check if all the API are deployed during the server startup Health check to check if all the API are deployed during the server startup
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • serverStartupHealthcheckGetWithHttpInfo

        public ApiResponse<Void> serverStartupHealthcheckGetWithHttpInfo()
                                                          throws ApiException
        Health check to check if all the API are deployed during the server startup Health check to check if all the API are deployed during the server startup
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • serverStartupHealthcheckGetAsync

        public com.squareup.okhttp.Call serverStartupHealthcheckGetAsync​(ApiCallback<Void> callback)
                                                          throws ApiException
        Health check to check if all the API are deployed during the server startup (asynchronously) Health check to check if all the API are deployed during the server startup
        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

      • undeployAPICall

        public com.squareup.okhttp.Call undeployAPICall​(String apiName,
                                                String version,
                                                String tenantDomain,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException
        Build call for undeployAPI
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • undeployAPI

        public DeployResponseDTO undeployAPI​(String apiName,
                                     String version,
                                     String tenantDomain)
                              throws ApiException
        Uneploy the API in the gateway This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        DeployResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • undeployAPIWithHttpInfo

        public ApiResponse<DeployResponseDTO> undeployAPIWithHttpInfo​(String apiName,
                                                              String version,
                                                              String tenantDomain)
                                                       throws ApiException
        Uneploy the API in the gateway This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (optional)
        Returns:
        ApiResponse<DeployResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • undeployAPIAsync

        public com.squareup.okhttp.Call undeployAPIAsync​(String apiName,
                                                 String version,
                                                 String tenantDomain,
                                                 ApiCallback<DeployResponseDTO> callback)
                                          throws ApiException
        Uneploy the API in the gateway (asynchronously) This operation is used to undeploy an API in the gateway. If the Tenant domain is not provided carbon.super will be picked as the Tenant domain.
        Parameters:
        apiName - Name of the API (required)
        version - version of the API (required)
        tenantDomain - Tenant Domain of the API (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