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

Class ApiRevisionsApi

java.lang.Object

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

public class ApiRevisionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiRevisionsApi()
ApiRevisionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIRevisionDTO	createAPIRevision(String apiId, APIRevisionDTO apIRevisionDTO) Create a new API revision Create a new API revision
okhttp3.Call	createAPIRevisionAsync(String apiId, APIRevisionDTO apIRevisionDTO, ApiCallback<APIRevisionDTO> _callback) Create a new API revision (asynchronously) Create a new API revision
okhttp3.Call	createAPIRevisionCall(String apiId, APIRevisionDTO apIRevisionDTO, ApiCallback _callback) Build call for createAPIRevision
ApiResponse<APIRevisionDTO>	createAPIRevisionWithHttpInfo(String apiId, APIRevisionDTO apIRevisionDTO) Create a new API revision Create a new API revision
APIRevisionListDTO	deleteAPIRevision(String apiId, String revisionId) Delete a revision of an API Delete a revision of an API
okhttp3.Call	deleteAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIRevisionListDTO> _callback) Delete a revision of an API (asynchronously) Delete a revision of an API
okhttp3.Call	deleteAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) Build call for deleteAPIRevision
ApiResponse<APIRevisionListDTO>	deleteAPIRevisionWithHttpInfo(String apiId, String revisionId) Delete a revision of an API Delete a revision of an API
void	deployAPIRevision(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) Deploy a revision Deploy a revision
okhttp3.Call	deployAPIRevisionAsync(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<Void> _callback) Deploy a revision (asynchronously) Deploy a revision
okhttp3.Call	deployAPIRevisionCall(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) Build call for deployAPIRevision
ApiResponse<Void>	deployAPIRevisionWithHttpInfo(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) Deploy a revision Deploy a revision
ApiClient	getApiClient()
APIRevisionDTO	getAPIRevision(String apiId, String revisionId) Retrieve a revision of an API Retrieve a revision of an API
okhttp3.Call	getAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIRevisionDTO> _callback) Retrieve a revision of an API (asynchronously) Retrieve a revision of an API
okhttp3.Call	getAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) Build call for getAPIRevision
APIRevisionDeploymentListDTO	getAPIRevisionDeployments(String apiId) List available deployed revision deployment details of an API List available deployed revision deployment details of an API
okhttp3.Call	getAPIRevisionDeploymentsAsync(String apiId, ApiCallback<APIRevisionDeploymentListDTO> _callback) List available deployed revision deployment details of an API (asynchronously) List available deployed revision deployment details of an API
okhttp3.Call	getAPIRevisionDeploymentsCall(String apiId, ApiCallback _callback) Build call for getAPIRevisionDeployments
ApiResponse<APIRevisionDeploymentListDTO>	getAPIRevisionDeploymentsWithHttpInfo(String apiId) List available deployed revision deployment details of an API List available deployed revision deployment details of an API
APIRevisionListDTO	getAPIRevisions(String apiId, String query) List available revisions of an API List available revisions of an API
okhttp3.Call	getAPIRevisionsAsync(String apiId, String query, ApiCallback<APIRevisionListDTO> _callback) List available revisions of an API (asynchronously) List available revisions of an API
okhttp3.Call	getAPIRevisionsCall(String apiId, String query, ApiCallback _callback) Build call for getAPIRevisions
ApiResponse<APIRevisionListDTO>	getAPIRevisionsWithHttpInfo(String apiId, String query) List available revisions of an API List available revisions of an API
ApiResponse<APIRevisionDTO>	getAPIRevisionWithHttpInfo(String apiId, String revisionId) Retrieve a revision of an API Retrieve a revision of an API
APIDTO	restoreAPIRevision(String apiId, String revisionId) Restore a revision Restore a revision to the working copy of the API
okhttp3.Call	restoreAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIDTO> _callback) Restore a revision (asynchronously) Restore a revision to the working copy of the API
okhttp3.Call	restoreAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) Build call for restoreAPIRevision
ApiResponse<APIDTO>	restoreAPIRevisionWithHttpInfo(String apiId, String revisionId) Restore a revision Restore a revision to the working copy of the API
void	setApiClient(ApiClient apiClient)
void	undeployAPIRevision(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) Un-Deploy a revision Un-Deploy a revision
okhttp3.Call	undeployAPIRevisionAsync(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<Void> _callback) Un-Deploy a revision (asynchronously) Un-Deploy a revision
okhttp3.Call	undeployAPIRevisionCall(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) Build call for undeployAPIRevision
ApiResponse<Void>	undeployAPIRevisionWithHttpInfo(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) Un-Deploy a revision Un-Deploy a revision

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiRevisionsApi

public ApiRevisionsApi()

ApiRevisionsApi

public ApiRevisionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAPIRevisionCall

public okhttp3.Call createAPIRevisionCall(String apiId,
                                          APIRevisionDTO apIRevisionDTO,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for createAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

apIRevisionDTO - API object that needs to be added (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createAPIRevision

public APIRevisionDTO createAPIRevision(String apiId,
                                        APIRevisionDTO apIRevisionDTO)
                                 throws ApiException

Create a new API revision Create a new API revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

apIRevisionDTO - API object that needs to be added (optional)

Returns:

APIRevisionDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createAPIRevisionWithHttpInfo

public ApiResponse<APIRevisionDTO> createAPIRevisionWithHttpInfo(String apiId,
                                                                 APIRevisionDTO apIRevisionDTO)
                                                          throws ApiException

Create a new API revision Create a new API revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

apIRevisionDTO - API object that needs to be added (optional)

Returns:

ApiResponse<APIRevisionDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createAPIRevisionAsync

public okhttp3.Call createAPIRevisionAsync(String apiId,
                                           APIRevisionDTO apIRevisionDTO,
                                           ApiCallback<APIRevisionDTO> _callback)
                                    throws ApiException

Create a new API revision (asynchronously) Create a new API revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

apIRevisionDTO - API object that needs to be added (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

deleteAPIRevisionCall

public okhttp3.Call deleteAPIRevisionCall(String apiId,
                                          String revisionId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deleteAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAPIRevision

public APIRevisionListDTO deleteAPIRevision(String apiId,
                                            String revisionId)
                                     throws ApiException

Delete a revision of an API Delete a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

Returns:

APIRevisionListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAPIRevisionWithHttpInfo

public ApiResponse<APIRevisionListDTO> deleteAPIRevisionWithHttpInfo(String apiId,
                                                                     String revisionId)
                                                              throws ApiException

Delete a revision of an API Delete a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

Returns:

ApiResponse<APIRevisionListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteAPIRevisionAsync

public okhttp3.Call deleteAPIRevisionAsync(String apiId,
                                           String revisionId,
                                           ApiCallback<APIRevisionListDTO> _callback)
                                    throws ApiException

Delete a revision of an API (asynchronously) Delete a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (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

deployAPIRevisionCall

public okhttp3.Call deployAPIRevisionCall(String apiId,
                                          String revisionId,
                                          List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deployAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deployAPIRevision

public void deployAPIRevision(String apiId,
                              String revisionId,
                              List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO)
                       throws ApiException

Deploy a revision Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deployAPIRevisionWithHttpInfo

public ApiResponse<Void> deployAPIRevisionWithHttpInfo(String apiId,
                                                       String revisionId,
                                                       List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO)
                                                throws ApiException

Deploy a revision Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deployAPIRevisionAsync

public okhttp3.Call deployAPIRevisionAsync(String apiId,
                                           String revisionId,
                                           List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO,
                                           ApiCallback<Void> _callback)
                                    throws ApiException

Deploy a revision (asynchronously) Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

apIRevisionDeploymentDTO - Deployment object that needs to be added (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

getAPIRevisionCall

public okhttp3.Call getAPIRevisionCall(String apiId,
                                       String revisionId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIRevision

public APIRevisionDTO getAPIRevision(String apiId,
                                     String revisionId)
                              throws ApiException

Retrieve a revision of an API Retrieve a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

Returns:

APIRevisionDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionWithHttpInfo

public ApiResponse<APIRevisionDTO> getAPIRevisionWithHttpInfo(String apiId,
                                                              String revisionId)
                                                       throws ApiException

Retrieve a revision of an API Retrieve a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (required)

Returns:

ApiResponse<APIRevisionDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionAsync

public okhttp3.Call getAPIRevisionAsync(String apiId,
                                        String revisionId,
                                        ApiCallback<APIRevisionDTO> _callback)
                                 throws ApiException

Retrieve a revision of an API (asynchronously) Retrieve a revision of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (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

getAPIRevisionDeploymentsCall

public okhttp3.Call getAPIRevisionDeploymentsCall(String apiId,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getAPIRevisionDeployments

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIRevisionDeployments

public APIRevisionDeploymentListDTO getAPIRevisionDeployments(String apiId)
                                                       throws ApiException

List available deployed revision deployment details of an API List available deployed revision deployment details of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

Returns:

APIRevisionDeploymentListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionDeploymentsWithHttpInfo

public ApiResponse<APIRevisionDeploymentListDTO> getAPIRevisionDeploymentsWithHttpInfo(String apiId)
                                                                                throws ApiException

List available deployed revision deployment details of an API List available deployed revision deployment details of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

Returns:

ApiResponse<APIRevisionDeploymentListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionDeploymentsAsync

public okhttp3.Call getAPIRevisionDeploymentsAsync(String apiId,
                                                   ApiCallback<APIRevisionDeploymentListDTO> _callback)
                                            throws ApiException

List available deployed revision deployment details of an API (asynchronously) List available deployed revision deployment details of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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

getAPIRevisionsCall

public okhttp3.Call getAPIRevisionsCall(String apiId,
                                        String query,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getAPIRevisions

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

query - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIRevisions

public APIRevisionListDTO getAPIRevisions(String apiId,
                                          String query)
                                   throws ApiException

List available revisions of an API List available revisions of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

query - (optional)

Returns:

APIRevisionListDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionsWithHttpInfo

public ApiResponse<APIRevisionListDTO> getAPIRevisionsWithHttpInfo(String apiId,
                                                                   String query)
                                                            throws ApiException

List available revisions of an API List available revisions of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

query - (optional)

Returns:

ApiResponse<APIRevisionListDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAPIRevisionsAsync

public okhttp3.Call getAPIRevisionsAsync(String apiId,
                                         String query,
                                         ApiCallback<APIRevisionListDTO> _callback)
                                  throws ApiException

List available revisions of an API (asynchronously) List available revisions of an API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

query - (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

restoreAPIRevisionCall

public okhttp3.Call restoreAPIRevisionCall(String apiId,
                                           String revisionId,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for restoreAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

restoreAPIRevision

public APIDTO restoreAPIRevision(String apiId,
                                 String revisionId)
                          throws ApiException

Restore a revision Restore a revision to the working copy of the API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

Returns:

APIDTO

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

restoreAPIRevisionWithHttpInfo

public ApiResponse<APIDTO> restoreAPIRevisionWithHttpInfo(String apiId,
                                                          String revisionId)
                                                   throws ApiException

Restore a revision Restore a revision to the working copy of the API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

Returns:

ApiResponse<APIDTO>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

restoreAPIRevisionAsync

public okhttp3.Call restoreAPIRevisionAsync(String apiId,
                                            String revisionId,
                                            ApiCallback<APIDTO> _callback)
                                     throws ApiException

Restore a revision (asynchronously) Restore a revision to the working copy of the API

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an 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

undeployAPIRevisionCall

public okhttp3.Call undeployAPIRevisionCall(String apiId,
                                            String revisionId,
                                            String revisionNumber,
                                            Boolean allEnvironments,
                                            List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for undeployAPIRevision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

revisionNumber - Revision Number of an API (optional)

allEnvironments - (optional, default to false)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

undeployAPIRevision

public void undeployAPIRevision(String apiId,
                                String revisionId,
                                String revisionNumber,
                                Boolean allEnvironments,
                                List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO)
                         throws ApiException

Un-Deploy a revision Un-Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

revisionNumber - Revision Number of an API (optional)

allEnvironments - (optional, default to false)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

undeployAPIRevisionWithHttpInfo

public ApiResponse<Void> undeployAPIRevisionWithHttpInfo(String apiId,
                                                         String revisionId,
                                                         String revisionNumber,
                                                         Boolean allEnvironments,
                                                         List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO)
                                                  throws ApiException

Un-Deploy a revision Un-Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

revisionNumber - Revision Number of an API (optional)

allEnvironments - (optional, default to false)

apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

undeployAPIRevisionAsync

public okhttp3.Call undeployAPIRevisionAsync(String apiId,
                                             String revisionId,
                                             String revisionNumber,
                                             Boolean allEnvironments,
                                             List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO,
                                             ApiCallback<Void> _callback)
                                      throws ApiException

Un-Deploy a revision (asynchronously) Un-Deploy a revision

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

revisionId - Revision ID of an API (optional)

revisionNumber - Revision Number of an API (optional)

allEnvironments - (optional, default to false)

apIRevisionDeploymentDTO - Deployment object that needs to be added (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