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

Class ApiProductLifecycleApi

java.lang.Object

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

public class ApiProductLifecycleApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiProductLifecycleApi()
ApiProductLifecycleApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
WorkflowResponseDTO	changeAPIProductLifecycle(String action, String apiProductId, String lifecycleChecklist, String ifMatch) Change API Product LC Status This operation is used to change the lifecycle of an API Product.
okhttp3.Call	changeAPIProductLifecycleAsync(String action, String apiProductId, String lifecycleChecklist, String ifMatch, ApiCallback<WorkflowResponseDTO> _callback) Change API Product LC Status (asynchronously) This operation is used to change the lifecycle of an API Product.
okhttp3.Call	changeAPIProductLifecycleCall(String action, String apiProductId, String lifecycleChecklist, String ifMatch, ApiCallback _callback) Build call for changeAPIProductLifecycle
ApiResponse<WorkflowResponseDTO>	changeAPIProductLifecycleWithHttpInfo(String action, String apiProductId, String lifecycleChecklist, String ifMatch) Change API Product LC Status This operation is used to change the lifecycle of an API Product.
void	deleteAPIProductLifecycleStatePendingTasks(String apiProductId) Delete Pending Lifecycle State Change Tasks This operation can be used to remove pending lifecycle state change requests that are in pending state
okhttp3.Call	deleteAPIProductLifecycleStatePendingTasksAsync(String apiProductId, ApiCallback<Void> _callback) Delete Pending Lifecycle State Change Tasks (asynchronously) This operation can be used to remove pending lifecycle state change requests that are in pending state
okhttp3.Call	deleteAPIProductLifecycleStatePendingTasksCall(String apiProductId, ApiCallback _callback) Build call for deleteAPIProductLifecycleStatePendingTasks
ApiResponse<Void>	deleteAPIProductLifecycleStatePendingTasksWithHttpInfo(String apiProductId) Delete Pending Lifecycle State Change Tasks This operation can be used to remove pending lifecycle state change requests that are in pending state
ApiClient	getApiClient()
LifecycleHistoryDTO	getAPIProductLifecycleHistory(String apiProductId, String ifNoneMatch) Get Lifecycle State Change History of the API Products.
okhttp3.Call	getAPIProductLifecycleHistoryAsync(String apiProductId, String ifNoneMatch, ApiCallback<LifecycleHistoryDTO> _callback) Get Lifecycle State Change History of the API Products.
okhttp3.Call	getAPIProductLifecycleHistoryCall(String apiProductId, String ifNoneMatch, ApiCallback _callback) Build call for getAPIProductLifecycleHistory
ApiResponse<LifecycleHistoryDTO>	getAPIProductLifecycleHistoryWithHttpInfo(String apiProductId, String ifNoneMatch) Get Lifecycle State Change History of the API Products.
LifecycleStateDTO	getAPIProductLifecycleState(String apiProductId, String ifNoneMatch) Get Lifecycle State Data of the API Product.
okhttp3.Call	getAPIProductLifecycleStateAsync(String apiProductId, String ifNoneMatch, ApiCallback<LifecycleStateDTO> _callback) Get Lifecycle State Data of the API Product.
okhttp3.Call	getAPIProductLifecycleStateCall(String apiProductId, String ifNoneMatch, ApiCallback _callback) Build call for getAPIProductLifecycleState
ApiResponse<LifecycleStateDTO>	getAPIProductLifecycleStateWithHttpInfo(String apiProductId, String ifNoneMatch) Get Lifecycle State Data of the API Product.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiProductLifecycleApi

public ApiProductLifecycleApi()

ApiProductLifecycleApi

public ApiProductLifecycleApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

changeAPIProductLifecycleCall

public okhttp3.Call changeAPIProductLifecycleCall(String action,
                                                  String apiProductId,
                                                  String lifecycleChecklist,
                                                  String ifMatch,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for changeAPIProductLifecycle

Parameters:

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

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

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the API**: Setting this to true will deprecate older versions of a particular API Product when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API Products although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the API:true\" will deprecate older versions of a particular API Product 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/v3/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (optional)

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

changeAPIProductLifecycle

public WorkflowResponseDTO changeAPIProductLifecycle(String action,
                                                     String apiProductId,
                                                     String lifecycleChecklist,
                                                     String ifMatch)
                                              throws ApiException

Change API Product LC Status This operation is used to change the lifecycle of an API Product. Eg: Publish an API Product 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 Product, `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 Product. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)

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

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the API**: Setting this to true will deprecate older versions of a particular API Product when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API Products although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the API:true\" will deprecate older versions of a particular API Product 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/v3/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (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

changeAPIProductLifecycleWithHttpInfo

public ApiResponse<WorkflowResponseDTO> changeAPIProductLifecycleWithHttpInfo(String action,
                                                                              String apiProductId,
                                                                              String lifecycleChecklist,
                                                                              String ifMatch)
                                                                       throws ApiException

Change API Product LC Status This operation is used to change the lifecycle of an API Product. Eg: Publish an API Product 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 Product, `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 Product. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)

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

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the API**: Setting this to true will deprecate older versions of a particular API Product when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API Products although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the API:true\" will deprecate older versions of a particular API Product 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/v3/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (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

changeAPIProductLifecycleAsync

public okhttp3.Call changeAPIProductLifecycleAsync(String action,
                                                   String apiProductId,
                                                   String lifecycleChecklist,
                                                   String ifMatch,
                                                   ApiCallback<WorkflowResponseDTO> _callback)
                                            throws ApiException

Change API Product LC Status (asynchronously) This operation is used to change the lifecycle of an API Product. Eg: Publish an API Product 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 Product, `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 Product. Supported actions are [ **Publish**, **Deploy as a Prototype**, **Demote to Created**, **Block**, **Deprecate**, **Re-Publish**, **Retire** ] (required)

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

lifecycleChecklist - Supported checklist items are as follows. 1. **Deprecate old versions after publishing the API**: Setting this to true will deprecate older versions of a particular API Product when it is promoted to Published state from Created state. 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API Products although they may have subscribed to an older version. You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate old versions after publishing the API:true\" will deprecate older versions of a particular API Product 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/v3/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse\" (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

deleteAPIProductLifecycleStatePendingTasksCall

public okhttp3.Call deleteAPIProductLifecycleStatePendingTasksCall(String apiProductId,
                                                                   ApiCallback _callback)
                                                            throws ApiException

Build call for deleteAPIProductLifecycleStatePendingTasks

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteAPIProductLifecycleStatePendingTasks

public void deleteAPIProductLifecycleStatePendingTasks(String apiProductId)
                                                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:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

Throws:

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

deleteAPIProductLifecycleStatePendingTasksWithHttpInfo

public ApiResponse<Void> deleteAPIProductLifecycleStatePendingTasksWithHttpInfo(String apiProductId)
                                                                         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:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteAPIProductLifecycleStatePendingTasksAsync

public okhttp3.Call deleteAPIProductLifecycleStatePendingTasksAsync(String apiProductId,
                                                                    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:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleHistoryCall

public okhttp3.Call getAPIProductLifecycleHistoryCall(String apiProductId,
                                                      String ifNoneMatch,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for getAPIProductLifecycleHistory

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIProductLifecycleHistory

public LifecycleHistoryDTO getAPIProductLifecycleHistory(String apiProductId,
                                                         String ifNoneMatch)
                                                  throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleHistoryWithHttpInfo

public ApiResponse<LifecycleHistoryDTO> getAPIProductLifecycleHistoryWithHttpInfo(String apiProductId,
                                                                                  String ifNoneMatch)
                                                                           throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleHistoryAsync

public okhttp3.Call getAPIProductLifecycleHistoryAsync(String apiProductId,
                                                       String ifNoneMatch,
                                                       ApiCallback<LifecycleHistoryDTO> _callback)
                                                throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleStateCall

public okhttp3.Call getAPIProductLifecycleStateCall(String apiProductId,
                                                    String ifNoneMatch,
                                                    ApiCallback _callback)
                                             throws ApiException

Build call for getAPIProductLifecycleState

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

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

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAPIProductLifecycleState

public LifecycleStateDTO getAPIProductLifecycleState(String apiProductId,
                                                     String ifNoneMatch)
                                              throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleStateWithHttpInfo

public ApiResponse<LifecycleStateDTO> getAPIProductLifecycleStateWithHttpInfo(String apiProductId,
                                                                              String ifNoneMatch)
                                                                       throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

getAPIProductLifecycleStateAsync

public okhttp3.Call getAPIProductLifecycleStateAsync(String apiProductId,
                                                     String ifNoneMatch,
                                                     ApiCallback<LifecycleStateDTO> _callback)
                                              throws ApiException

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

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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