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

Class ApiLifecycleApi

java.lang.Object

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

public class ApiLifecycleApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiLifecycleApi()
ApiLifecycleApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
LifecycleHistoryDTO	apisApiIdLifecycleHistoryGet(String apiId, String ifNoneMatch) Get Lifecycle state change history of the API.
com.squareup.okhttp.Call	apisApiIdLifecycleHistoryGetAsync(String apiId, String ifNoneMatch, ApiCallback<LifecycleHistoryDTO> callback) Get Lifecycle state change history of the API.
com.squareup.okhttp.Call	apisApiIdLifecycleHistoryGetCall(String apiId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdLifecycleHistoryGet
ApiResponse<LifecycleHistoryDTO>	apisApiIdLifecycleHistoryGetWithHttpInfo(String apiId, String ifNoneMatch) Get Lifecycle state change history of the API.
LifecycleStateDTO	apisApiIdLifecycleStateGet(String apiId, String ifNoneMatch) Get Lifecycle state data of the API.
com.squareup.okhttp.Call	apisApiIdLifecycleStateGetAsync(String apiId, String ifNoneMatch, ApiCallback<LifecycleStateDTO> callback) Get Lifecycle state data of the API.
com.squareup.okhttp.Call	apisApiIdLifecycleStateGetCall(String apiId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdLifecycleStateGet
ApiResponse<LifecycleStateDTO>	apisApiIdLifecycleStateGetWithHttpInfo(String apiId, String ifNoneMatch) Get Lifecycle state data of the API.
void	apisApiIdLifecycleStatePendingTasksDelete(String apiId) Delete pending lifecycle state change tasks.
com.squareup.okhttp.Call	apisApiIdLifecycleStatePendingTasksDeleteAsync(String apiId, ApiCallback<Void> callback) Delete pending lifecycle state change tasks.
com.squareup.okhttp.Call	apisApiIdLifecycleStatePendingTasksDeleteCall(String apiId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdLifecycleStatePendingTasksDelete
ApiResponse<Void>	apisApiIdLifecycleStatePendingTasksDeleteWithHttpInfo(String apiId) Delete pending lifecycle state change tasks.
WorkflowResponseDTO	apisChangeLifecyclePost(String action, String apiId, String lifecycleChecklist, String ifMatch) Change API Status This operation is used to change the lifecycle of an API.
com.squareup.okhttp.Call	apisChangeLifecyclePostAsync(String action, String apiId, String lifecycleChecklist, String ifMatch, ApiCallback<WorkflowResponseDTO> callback) Change API Status (asynchronously) This operation is used to change the lifecycle of an API.
com.squareup.okhttp.Call	apisChangeLifecyclePostCall(String action, String apiId, String lifecycleChecklist, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisChangeLifecyclePost
ApiResponse<WorkflowResponseDTO>	apisChangeLifecyclePostWithHttpInfo(String action, String apiId, String lifecycleChecklist, String ifMatch) Change API Status This operation is used to change the lifecycle of an API.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiLifecycleApi

public ApiLifecycleApi()

ApiLifecycleApi

public ApiLifecycleApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdLifecycleHistoryGetCall

public com.squareup.okhttp.Call apisApiIdLifecycleHistoryGetCall(String apiId,
                                                                 String ifNoneMatch,
                                                                 ProgressResponseBody.ProgressListener progressListener,
                                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                          throws ApiException

Build call for apisApiIdLifecycleHistoryGet

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdLifecycleHistoryGet

public LifecycleHistoryDTO apisApiIdLifecycleHistoryGet(String apiId,
                                                        String ifNoneMatch)
                                                 throws ApiException

Get Lifecycle state change history of the API. This operation can be used to retrieve Lifecycle state change history of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

LifecycleHistoryDTO

Throws:

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

apisApiIdLifecycleHistoryGetWithHttpInfo

public ApiResponse<LifecycleHistoryDTO> apisApiIdLifecycleHistoryGetWithHttpInfo(String apiId,
                                                                                 String ifNoneMatch)
                                                                          throws ApiException

Get Lifecycle state change history of the API. This operation can be used to retrieve Lifecycle state change history of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<LifecycleHistoryDTO>

Throws:

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

apisApiIdLifecycleHistoryGetAsync

public com.squareup.okhttp.Call apisApiIdLifecycleHistoryGetAsync(String apiId,
                                                                  String ifNoneMatch,
                                                                  ApiCallback<LifecycleHistoryDTO> callback)
                                                           throws ApiException

Get Lifecycle state change history of the API. (asynchronously) This operation can be used to retrieve Lifecycle state change history of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apisApiIdLifecycleStateGetCall

public com.squareup.okhttp.Call apisApiIdLifecycleStateGetCall(String apiId,
                                                               String ifNoneMatch,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for apisApiIdLifecycleStateGet

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdLifecycleStateGet

public LifecycleStateDTO apisApiIdLifecycleStateGet(String apiId,
                                                    String ifNoneMatch)
                                             throws ApiException

Get Lifecycle state data of the API. This operation can be used to retrieve Lifecycle state data of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

LifecycleStateDTO

Throws:

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

apisApiIdLifecycleStateGetWithHttpInfo

public ApiResponse<LifecycleStateDTO> apisApiIdLifecycleStateGetWithHttpInfo(String apiId,
                                                                             String ifNoneMatch)
                                                                      throws ApiException

Get Lifecycle state data of the API. This operation can be used to retrieve Lifecycle state data of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<LifecycleStateDTO>

Throws:

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

apisApiIdLifecycleStateGetAsync

public com.squareup.okhttp.Call apisApiIdLifecycleStateGetAsync(String apiId,
                                                                String ifNoneMatch,
                                                                ApiCallback<LifecycleStateDTO> callback)
                                                         throws ApiException

Get Lifecycle state data of the API. (asynchronously) This operation can be used to retrieve Lifecycle state data of the API.

Parameters:

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

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apisApiIdLifecycleStatePendingTasksDeleteCall

public com.squareup.okhttp.Call apisApiIdLifecycleStatePendingTasksDeleteCall(String apiId,
                                                                              ProgressResponseBody.ProgressListener progressListener,
                                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                       throws ApiException

Build call for apisApiIdLifecycleStatePendingTasksDelete

Parameters:

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdLifecycleStatePendingTasksDelete

public void apisApiIdLifecycleStatePendingTasksDelete(String apiId)
                                               throws ApiException

Delete pending lifecycle state change tasks. This operation can be used to remove pending lifecycle state change requests that are in pending state

Parameters:

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

Throws:

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

apisApiIdLifecycleStatePendingTasksDeleteWithHttpInfo

public ApiResponse<Void> apisApiIdLifecycleStatePendingTasksDeleteWithHttpInfo(String apiId)
                                                                        throws ApiException

Delete pending lifecycle state change tasks. This operation can be used to remove pending lifecycle state change requests that are in pending state

Parameters:

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

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdLifecycleStatePendingTasksDeleteAsync

public com.squareup.okhttp.Call apisApiIdLifecycleStatePendingTasksDeleteAsync(String apiId,
                                                                               ApiCallback<Void> callback)
                                                                        throws ApiException

Delete pending lifecycle state change tasks. (asynchronously) This operation can be used to remove pending lifecycle state change requests that are in pending state

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

apisChangeLifecyclePostCall

public com.squareup.okhttp.Call apisChangeLifecyclePostCall(String action,
                                                            String apiId,
                                                            String lifecycleChecklist,
                                                            String ifMatch,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for apisChangeLifecyclePost

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate Old Versions:true,Require Re-Subscription:true\" (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisChangeLifecyclePost

public WorkflowResponseDTO apisChangeLifecyclePost(String action,
                                                   String apiId,
                                                   String lifecycleChecklist,
                                                   String ifMatch)
                                            throws ApiException

Change API Status This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate Old Versions:true,Require Re-Subscription:true\" (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

WorkflowResponseDTO

Throws:

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

apisChangeLifecyclePostWithHttpInfo

public ApiResponse<WorkflowResponseDTO> apisChangeLifecyclePostWithHttpInfo(String action,
                                                                            String apiId,
                                                                            String lifecycleChecklist,
                                                                            String ifMatch)
                                                                     throws ApiException

Change API Status This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate Old Versions:true,Require Re-Subscription:true\" (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<WorkflowResponseDTO>

Throws:

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

apisChangeLifecyclePostAsync

public com.squareup.okhttp.Call apisChangeLifecyclePostAsync(String action,
                                                             String apiId,
                                                             String lifecycleChecklist,
                                                             String ifMatch,
                                                             ApiCallback<WorkflowResponseDTO> callback)
                                                      throws ApiException

Change API Status (asynchronously) This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Note that the `Re-publish` action is available only after calling `Block`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. **Sample CURL :** curl -k -H \"Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate Old Versions:true,Require Re-Subscription:true\" (optional)

ifMatch - Validator for conditional requests; based on ETag. (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