org.ow2.proactive.pca.service.client.api

Class CatalogRestApi

java.lang.Object

org.ow2.proactive.pca.service.client.api.CatalogRestApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-02-12T14:43:58.169865-05:00[America/New_York]")
public class CatalogRestApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CatalogRestApi()
CatalogRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client
CloudAutomationWorkflow	getExecutableActionByCatalogObject(String sessionid, Long instanceId, String bucketName, String workflowName) Get ProActive Service Automation executable workflow by bucket and workflow names
ApiResponse<CloudAutomationWorkflow>	getExecutableActionByCatalogObjectWithHttpInfo(String sessionid, Long instanceId, String bucketName, String workflowName) Get ProActive Service Automation executable workflow by bucket and workflow names
CloudAutomationWorkflow	getWorkflowByCatalogObject(String sessionid, String bucketName, String workflowName) Get ProActive Service Automation workflow by bucket and workflow names
ApiResponse<CloudAutomationWorkflow>	getWorkflowByCatalogObjectWithHttpInfo(String sessionid, String bucketName, String workflowName) Get ProActive Service Automation workflow by bucket and workflow names
List<CloudAutomationWorkflow>	getWorkflowsByServiceId(String sessionid, String serviceId) Get ProActive Service Automation workflows by service id
ApiResponse<List<CloudAutomationWorkflow>>	getWorkflowsByServiceIdWithHttpInfo(String sessionid, String serviceId) Get ProActive Service Automation workflows by service id
List<CloudAutomationWorkflow>	listActionWorkflows(String sessionid) List ProActive Service Automation action workflows
ApiResponse<List<CloudAutomationWorkflow>>	listActionWorkflowsWithHttpInfo(String sessionid) List ProActive Service Automation action workflows
Map<String,List<CloudAutomationWorkflow>>	listAllWorkflowsByServiceId(String sessionid) List ProActive Service Automation workflows by service id
ApiResponse<Map<String,List<CloudAutomationWorkflow>>>	listAllWorkflowsByServiceIdWithHttpInfo(String sessionid) List ProActive Service Automation workflows by service id
Map<String,List<CloudAutomationWorkflow>>	listAndRefreshAllWorkflowsByServiceId(String sessionid) Invalidate cache and list ProActive Service Automation workflows by service id
ApiResponse<Map<String,List<CloudAutomationWorkflow>>>	listAndRefreshAllWorkflowsByServiceIdWithHttpInfo(String sessionid) Invalidate cache and list ProActive Service Automation workflows by service id
Map<String,List<CloudAutomationWorkflow>>	listExecutableActionsByInstanceId(String sessionid, Long instanceId) List ProActive Service Automation executable workflows grouped by instance id.
Map<String,List<CloudAutomationWorkflow>>	listExecutableActionsByInstanceIds(String sessionid, List<Long> instanceIds) List ProActive Service Automation executable workflows grouped by instance ids for a given list of ids.
ApiResponse<Map<String,List<CloudAutomationWorkflow>>>	listExecutableActionsByInstanceIdsWithHttpInfo(String sessionid, List<Long> instanceIds) List ProActive Service Automation executable workflows grouped by instance ids for a given list of ids.
ApiResponse<Map<String,List<CloudAutomationWorkflow>>>	listExecutableActionsByInstanceIdWithHttpInfo(String sessionid, Long instanceId) List ProActive Service Automation executable workflows grouped by instance id.
List<CloudAutomationWorkflow>	listStartingWorkflows(String sessionid) List ProActive Service Automation starting workflows
Map<String,List<CloudAutomationWorkflow>>	listStartingWorkflowsByServiceId(String sessionid) List ProActive Service Automation starting workflows by service id
ApiResponse<Map<String,List<CloudAutomationWorkflow>>>	listStartingWorkflowsByServiceIdWithHttpInfo(String sessionid) List ProActive Service Automation starting workflows by service id
ApiResponse<List<CloudAutomationWorkflow>>	listStartingWorkflowsWithHttpInfo(String sessionid) List ProActive Service Automation starting workflows
CloudAutomationWorkflow	refreshWorkflowByServiceId(String sessionid, String serviceId, String workflowName, String bucketName) Invalidate cache for the given serviceId of ProActive Service Automation workflow and returns the updated workflow
ApiResponse<CloudAutomationWorkflow>	refreshWorkflowByServiceIdWithHttpInfo(String sessionid, String serviceId, String workflowName, String bucketName) Invalidate cache for the given serviceId of ProActive Service Automation workflow and returns the updated workflow
void	setApiClient(ApiClient apiClient) Set the API client

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogRestApi

public CatalogRestApi()

CatalogRestApi

public CatalogRestApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

getExecutableActionByCatalogObject

public CloudAutomationWorkflow getExecutableActionByCatalogObject(String sessionid,
                                                                  Long instanceId,
                                                                  String bucketName,
                                                                  String workflowName)
                                                           throws ApiException

Get ProActive Service Automation executable workflow by bucket and workflow names

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

bucketName - (required)

workflowName - (required)

Returns:

CloudAutomationWorkflow

Throws:

ApiException - if fails to make API call

getExecutableActionByCatalogObjectWithHttpInfo

public ApiResponse<CloudAutomationWorkflow> getExecutableActionByCatalogObjectWithHttpInfo(String sessionid,
                                                                                           Long instanceId,
                                                                                           String bucketName,
                                                                                           String workflowName)
                                                                                    throws ApiException

Get ProActive Service Automation executable workflow by bucket and workflow names

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

bucketName - (required)

workflowName - (required)

Returns:

ApiResponse<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call

getWorkflowByCatalogObject

public CloudAutomationWorkflow getWorkflowByCatalogObject(String sessionid,
                                                          String bucketName,
                                                          String workflowName)
                                                   throws ApiException

Get ProActive Service Automation workflow by bucket and workflow names

Parameters:

sessionid - Scheduler authentication id (required)

bucketName - (required)

workflowName - (required)

Returns:

CloudAutomationWorkflow

Throws:

ApiException - if fails to make API call

getWorkflowByCatalogObjectWithHttpInfo

public ApiResponse<CloudAutomationWorkflow> getWorkflowByCatalogObjectWithHttpInfo(String sessionid,
                                                                                   String bucketName,
                                                                                   String workflowName)
                                                                            throws ApiException

Get ProActive Service Automation workflow by bucket and workflow names

Parameters:

sessionid - Scheduler authentication id (required)

bucketName - (required)

workflowName - (required)

Returns:

ApiResponse<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call

getWorkflowsByServiceId

public List<CloudAutomationWorkflow> getWorkflowsByServiceId(String sessionid,
                                                             String serviceId)
                                                      throws ApiException

Get ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

serviceId - (required)

Returns:

List<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call

getWorkflowsByServiceIdWithHttpInfo

public ApiResponse<List<CloudAutomationWorkflow>> getWorkflowsByServiceIdWithHttpInfo(String sessionid,
                                                                                      String serviceId)
                                                                               throws ApiException

Get ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

serviceId - (required)

Returns:

ApiResponse<List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listActionWorkflows

public List<CloudAutomationWorkflow> listActionWorkflows(String sessionid)
                                                  throws ApiException

List ProActive Service Automation action workflows

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

List<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call

listActionWorkflowsWithHttpInfo

public ApiResponse<List<CloudAutomationWorkflow>> listActionWorkflowsWithHttpInfo(String sessionid)
                                                                           throws ApiException

List ProActive Service Automation action workflows

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

ApiResponse<List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listAllWorkflowsByServiceId

public Map<String,List<CloudAutomationWorkflow>> listAllWorkflowsByServiceId(String sessionid)
                                                                      throws ApiException

List ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

Map<String, List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listAllWorkflowsByServiceIdWithHttpInfo

public ApiResponse<Map<String,List<CloudAutomationWorkflow>>> listAllWorkflowsByServiceIdWithHttpInfo(String sessionid)
                                                                                               throws ApiException

List ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

ApiResponse<Map<String, List<CloudAutomationWorkflow>>>

Throws:

ApiException - if fails to make API call

listAndRefreshAllWorkflowsByServiceId

public Map<String,List<CloudAutomationWorkflow>> listAndRefreshAllWorkflowsByServiceId(String sessionid)
                                                                                throws ApiException

Invalidate cache and list ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

Map<String, List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listAndRefreshAllWorkflowsByServiceIdWithHttpInfo

public ApiResponse<Map<String,List<CloudAutomationWorkflow>>> listAndRefreshAllWorkflowsByServiceIdWithHttpInfo(String sessionid)
                                                                                                         throws ApiException

Invalidate cache and list ProActive Service Automation workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

ApiResponse<Map<String, List<CloudAutomationWorkflow>>>

Throws:

ApiException - if fails to make API call

listExecutableActionsByInstanceId

public Map<String,List<CloudAutomationWorkflow>> listExecutableActionsByInstanceId(String sessionid,
                                                                                   Long instanceId)
                                                                            throws ApiException

List ProActive Service Automation executable workflows grouped by instance id. If an instance id is provided as a parameter, it returns the list of PSA executable workflows for that instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (optional)

Returns:

Map<String, List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listExecutableActionsByInstanceIdWithHttpInfo

public ApiResponse<Map<String,List<CloudAutomationWorkflow>>> listExecutableActionsByInstanceIdWithHttpInfo(String sessionid,
                                                                                                            Long instanceId)
                                                                                                     throws ApiException

List ProActive Service Automation executable workflows grouped by instance id. If an instance id is provided as a parameter, it returns the list of PSA executable workflows for that instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (optional)

Returns:

ApiResponse<Map<String, List<CloudAutomationWorkflow>>>

Throws:

ApiException - if fails to make API call

listExecutableActionsByInstanceIds

public Map<String,List<CloudAutomationWorkflow>> listExecutableActionsByInstanceIds(String sessionid,
                                                                                    List<Long> instanceIds)
                                                                             throws ApiException

List ProActive Service Automation executable workflows grouped by instance ids for a given list of ids.

Parameters:

sessionid - Scheduler authentication id (required)

instanceIds - Services instances ids (optional)

Returns:

Map<String, List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listExecutableActionsByInstanceIdsWithHttpInfo

public ApiResponse<Map<String,List<CloudAutomationWorkflow>>> listExecutableActionsByInstanceIdsWithHttpInfo(String sessionid,
                                                                                                             List<Long> instanceIds)
                                                                                                      throws ApiException

List ProActive Service Automation executable workflows grouped by instance ids for a given list of ids.

Parameters:

sessionid - Scheduler authentication id (required)

instanceIds - Services instances ids (optional)

Returns:

ApiResponse<Map<String, List<CloudAutomationWorkflow>>>

Throws:

ApiException - if fails to make API call

listStartingWorkflows

public List<CloudAutomationWorkflow> listStartingWorkflows(String sessionid)
                                                    throws ApiException

List ProActive Service Automation starting workflows

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

List<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call

listStartingWorkflowsWithHttpInfo

public ApiResponse<List<CloudAutomationWorkflow>> listStartingWorkflowsWithHttpInfo(String sessionid)
                                                                             throws ApiException

List ProActive Service Automation starting workflows

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

ApiResponse<List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listStartingWorkflowsByServiceId

public Map<String,List<CloudAutomationWorkflow>> listStartingWorkflowsByServiceId(String sessionid)
                                                                           throws ApiException

List ProActive Service Automation starting workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

Map<String, List<CloudAutomationWorkflow>>

Throws:

ApiException - if fails to make API call

listStartingWorkflowsByServiceIdWithHttpInfo

public ApiResponse<Map<String,List<CloudAutomationWorkflow>>> listStartingWorkflowsByServiceIdWithHttpInfo(String sessionid)
                                                                                                    throws ApiException

List ProActive Service Automation starting workflows by service id

Parameters:

sessionid - Scheduler authentication id (required)

Returns:

ApiResponse<Map<String, List<CloudAutomationWorkflow>>>

Throws:

ApiException - if fails to make API call

refreshWorkflowByServiceId

public CloudAutomationWorkflow refreshWorkflowByServiceId(String sessionid,
                                                          String serviceId,
                                                          String workflowName,
                                                          String bucketName)
                                                   throws ApiException

Invalidate cache for the given serviceId of ProActive Service Automation workflow and returns the updated workflow

Parameters:

sessionid - Scheduler authentication id (required)

serviceId - (required)

workflowName - (required)

bucketName - (required)

Returns:

CloudAutomationWorkflow

Throws:

ApiException - if fails to make API call

refreshWorkflowByServiceIdWithHttpInfo

public ApiResponse<CloudAutomationWorkflow> refreshWorkflowByServiceIdWithHttpInfo(String sessionid,
                                                                                   String serviceId,
                                                                                   String workflowName,
                                                                                   String bucketName)
                                                                            throws ApiException

Invalidate cache for the given serviceId of ProActive Service Automation workflow and returns the updated workflow

Parameters:

sessionid - Scheduler authentication id (required)

serviceId - (required)

workflowName - (required)

bucketName - (required)

Returns:

ApiResponse<CloudAutomationWorkflow>

Throws:

ApiException - if fails to make API call