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

Class ServiceInstanceRestApi

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
ServiceInstanceRestApi()
ServiceInstanceRestApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ServiceInstanceData	createNewInstanceEndpoints(String sessionid, Long instanceId, Map<String,String> requestBody) Create new endpoints for the service instance
ApiResponse<ServiceInstanceData>	createNewInstanceEndpointsWithHttpInfo(String sessionid, Long instanceId, Map<String,String> requestBody) Create new endpoints for the service instance
ServiceInstanceData	createNewInstanceVariables(String sessionid, Long instanceId, Map<String,String> requestBody) Create new variables for the service instance
ApiResponse<ServiceInstanceData>	createNewInstanceVariablesWithHttpInfo(String sessionid, Long instanceId, Map<String,String> requestBody) Create new variables for the service instance
ServiceInstanceData	createRunningServiceInstance(String sessionid, ServiceDescription serviceDescription, Integer parentJobId) Create a new service instance
ApiResponse<ServiceInstanceData>	createRunningServiceInstanceWithHttpInfo(String sessionid, ServiceDescription serviceDescription, Integer parentJobId) Create a new service instance
ServiceInstanceData	deleteServiceInstancesFromDatabase(String sessionid, Long instanceId) Remove a service instance from the database
ApiResponse<ServiceInstanceData>	deleteServiceInstancesFromDatabaseWithHttpInfo(String sessionid, Long instanceId) Remove a service instance from the database
List<ServiceInstanceData>	getActiveServiceInstances(String sessionid, Boolean myServices) Get service instances information for all active services.
ApiResponse<List<ServiceInstanceData>>	getActiveServiceInstancesWithHttpInfo(String sessionid, Boolean myServices) Get service instances information for all active services.
ApiClient	getApiClient() Get the API client
Integer	getCountActiveServiceInstances(String sessionid, Boolean myServices) Get active service instances count.
ApiResponse<Integer>	getCountActiveServiceInstancesWithHttpInfo(String sessionid, Boolean myServices) Get active service instances count.
ServiceInstanceData	getServiceInstance(String sessionid, Long instanceId) Get a service instance information
List<ServiceInstanceData>	getServiceInstances(String sessionid, List<Long> instanceId) Get all service instances information for the provided comma separated list of instance ids or for all services if no instance id list is provided.
ApiResponse<List<ServiceInstanceData>>	getServiceInstancesWithHttpInfo(String sessionid, List<Long> instanceId) Get all service instances information for the provided comma separated list of instance ids or for all services if no instance id list is provided.
ApiResponse<ServiceInstanceData>	getServiceInstanceWithHttpInfo(String sessionid, Long instanceId) Get a service instance information
ServiceInstanceData	killServiceInstanceJobs(String sessionid, Long instanceId) Kill the running workflows of the instance
ApiResponse<ServiceInstanceData>	killServiceInstanceJobsWithHttpInfo(String sessionid, Long instanceId) Kill the running workflows of the instance
ServiceInstanceData	launchServiceInstanceAction(String sessionid, Long instanceId, ServiceDescription serviceDescription, Integer parentJobId) Launch an action on the instance
ApiResponse<ServiceInstanceData>	launchServiceInstanceActionWithHttpInfo(String sessionid, Long instanceId, ServiceDescription serviceDescription, Integer parentJobId) Launch an action on the instance
ServiceInstanceData	removeInstanceEndpoints(String sessionid, Long instanceId, List<String> requestBody) Remove the service instance endpoints
ApiResponse<ServiceInstanceData>	removeInstanceEndpointsWithHttpInfo(String sessionid, Long instanceId, List<String> requestBody) Remove the service instance endpoints
ServiceInstanceData	removeInstanceVariables(String sessionid, Long instanceId, List<String> requestBody) Remove the service instance variables
ApiResponse<ServiceInstanceData>	removeInstanceVariablesWithHttpInfo(String sessionid, Long instanceId, List<String> requestBody) Remove the service instance variables
void	setApiClient(ApiClient apiClient) Set the API client
ServiceInstanceData	updateServiceInstance(String sessionid, Long instanceId, ServiceInstanceData serviceInstanceData) Update the instance information
ApiResponse<ServiceInstanceData>	updateServiceInstanceWithHttpInfo(String sessionid, Long instanceId, ServiceInstanceData serviceInstanceData) Update the instance information

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInstanceRestApi

public ServiceInstanceRestApi()

ServiceInstanceRestApi

public ServiceInstanceRestApi(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

createNewInstanceEndpoints

public ServiceInstanceData createNewInstanceEndpoints(String sessionid,
                                                      Long instanceId,
                                                      Map<String,String> requestBody)
                                               throws ApiException

Create new endpoints for the service instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

createNewInstanceEndpointsWithHttpInfo

public ApiResponse<ServiceInstanceData> createNewInstanceEndpointsWithHttpInfo(String sessionid,
                                                                               Long instanceId,
                                                                               Map<String,String> requestBody)
                                                                        throws ApiException

Create new endpoints for the service instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

createNewInstanceVariables

public ServiceInstanceData createNewInstanceVariables(String sessionid,
                                                      Long instanceId,
                                                      Map<String,String> requestBody)
                                               throws ApiException

Create new variables for the service instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

createNewInstanceVariablesWithHttpInfo

public ApiResponse<ServiceInstanceData> createNewInstanceVariablesWithHttpInfo(String sessionid,
                                                                               Long instanceId,
                                                                               Map<String,String> requestBody)
                                                                        throws ApiException

Create new variables for the service instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

createRunningServiceInstance

public ServiceInstanceData createRunningServiceInstance(String sessionid,
                                                        ServiceDescription serviceDescription,
                                                        Integer parentJobId)
                                                 throws ApiException

Create a new service instance

Parameters:

sessionid - Scheduler authentication id (required)

serviceDescription - (required)

parentJobId - The Id of the Parent Job that submits this action (optional)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

createRunningServiceInstanceWithHttpInfo

public ApiResponse<ServiceInstanceData> createRunningServiceInstanceWithHttpInfo(String sessionid,
                                                                                 ServiceDescription serviceDescription,
                                                                                 Integer parentJobId)
                                                                          throws ApiException

Create a new service instance

Parameters:

sessionid - Scheduler authentication id (required)

serviceDescription - (required)

parentJobId - The Id of the Parent Job that submits this action (optional)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

deleteServiceInstancesFromDatabase

public ServiceInstanceData deleteServiceInstancesFromDatabase(String sessionid,
                                                              Long instanceId)
                                                       throws ApiException

Remove a service instance from the database

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

deleteServiceInstancesFromDatabaseWithHttpInfo

public ApiResponse<ServiceInstanceData> deleteServiceInstancesFromDatabaseWithHttpInfo(String sessionid,
                                                                                       Long instanceId)
                                                                                throws ApiException

Remove a service instance from the database

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

getActiveServiceInstances

public List<ServiceInstanceData> getActiveServiceInstances(String sessionid,
                                                           Boolean myServices)
                                                    throws ApiException

Get service instances information for all active services.

Parameters:

sessionid - Scheduler authentication id (required)

myServices - Include only services that belongs to the user sending the request (required)

Returns:

List<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

getActiveServiceInstancesWithHttpInfo

public ApiResponse<List<ServiceInstanceData>> getActiveServiceInstancesWithHttpInfo(String sessionid,
                                                                                    Boolean myServices)
                                                                             throws ApiException

Get service instances information for all active services.

Parameters:

sessionid - Scheduler authentication id (required)

myServices - Include only services that belongs to the user sending the request (required)

Returns:

ApiResponse<List<ServiceInstanceData>>

Throws:

ApiException - if fails to make API call

getCountActiveServiceInstances

public Integer getCountActiveServiceInstances(String sessionid,
                                              Boolean myServices)
                                       throws ApiException

Get active service instances count.

Parameters:

sessionid - Scheduler authentication id (required)

myServices - Include only services that belongs to the user sending the request (required)

Returns:

Integer

Throws:

ApiException - if fails to make API call

getCountActiveServiceInstancesWithHttpInfo

public ApiResponse<Integer> getCountActiveServiceInstancesWithHttpInfo(String sessionid,
                                                                       Boolean myServices)
                                                                throws ApiException

Get active service instances count.

Parameters:

sessionid - Scheduler authentication id (required)

myServices - Include only services that belongs to the user sending the request (required)

Returns:

ApiResponse<Integer>

Throws:

ApiException - if fails to make API call

getServiceInstance

public ServiceInstanceData getServiceInstance(String sessionid,
                                              Long instanceId)
                                       throws ApiException

Get a service instance information

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The service instance id (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

getServiceInstanceWithHttpInfo

public ApiResponse<ServiceInstanceData> getServiceInstanceWithHttpInfo(String sessionid,
                                                                       Long instanceId)
                                                                throws ApiException

Get a service instance information

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The service instance id (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

getServiceInstances

public List<ServiceInstanceData> getServiceInstances(String sessionid,
                                                     List<Long> instanceId)
                                              throws ApiException

Get all service instances information for the provided comma separated list of instance ids or for all services if no instance id list is provided.

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - Comma-separated list of service instance ids (optional)

Returns:

List<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

getServiceInstancesWithHttpInfo

public ApiResponse<List<ServiceInstanceData>> getServiceInstancesWithHttpInfo(String sessionid,
                                                                              List<Long> instanceId)
                                                                       throws ApiException

Get all service instances information for the provided comma separated list of instance ids or for all services if no instance id list is provided.

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - Comma-separated list of service instance ids (optional)

Returns:

ApiResponse<List<ServiceInstanceData>>

Throws:

ApiException - if fails to make API call

killServiceInstanceJobs

public ServiceInstanceData killServiceInstanceJobs(String sessionid,
                                                   Long instanceId)
                                            throws ApiException

Kill the running workflows of the instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

killServiceInstanceJobsWithHttpInfo

public ApiResponse<ServiceInstanceData> killServiceInstanceJobsWithHttpInfo(String sessionid,
                                                                            Long instanceId)
                                                                     throws ApiException

Kill the running workflows of the instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

launchServiceInstanceAction

public ServiceInstanceData launchServiceInstanceAction(String sessionid,
                                                       Long instanceId,
                                                       ServiceDescription serviceDescription,
                                                       Integer parentJobId)
                                                throws ApiException

Launch an action on the instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

serviceDescription - (required)

parentJobId - The Id of the Parent Job that submits this action (optional)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

launchServiceInstanceActionWithHttpInfo

public ApiResponse<ServiceInstanceData> launchServiceInstanceActionWithHttpInfo(String sessionid,
                                                                                Long instanceId,
                                                                                ServiceDescription serviceDescription,
                                                                                Integer parentJobId)
                                                                         throws ApiException

Launch an action on the instance

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

serviceDescription - (required)

parentJobId - The Id of the Parent Job that submits this action (optional)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

removeInstanceEndpoints

public ServiceInstanceData removeInstanceEndpoints(String sessionid,
                                                   Long instanceId,
                                                   List<String> requestBody)
                                            throws ApiException

Remove the service instance endpoints

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

removeInstanceEndpointsWithHttpInfo

public ApiResponse<ServiceInstanceData> removeInstanceEndpointsWithHttpInfo(String sessionid,
                                                                            Long instanceId,
                                                                            List<String> requestBody)
                                                                     throws ApiException

Remove the service instance endpoints

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

removeInstanceVariables

public ServiceInstanceData removeInstanceVariables(String sessionid,
                                                   Long instanceId,
                                                   List<String> requestBody)
                                            throws ApiException

Remove the service instance variables

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

removeInstanceVariablesWithHttpInfo

public ApiResponse<ServiceInstanceData> removeInstanceVariablesWithHttpInfo(String sessionid,
                                                                            Long instanceId,
                                                                            List<String> requestBody)
                                                                     throws ApiException

Remove the service instance variables

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - (required)

requestBody - (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call

updateServiceInstance

public ServiceInstanceData updateServiceInstance(String sessionid,
                                                 Long instanceId,
                                                 ServiceInstanceData serviceInstanceData)
                                          throws ApiException

Update the instance information

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

serviceInstanceData - (required)

Returns:

ServiceInstanceData

Throws:

ApiException - if fails to make API call

updateServiceInstanceWithHttpInfo

public ApiResponse<ServiceInstanceData> updateServiceInstanceWithHttpInfo(String sessionid,
                                                                          Long instanceId,
                                                                          ServiceInstanceData serviceInstanceData)
                                                                   throws ApiException

Update the instance information

Parameters:

sessionid - Scheduler authentication id (required)

instanceId - The instance id (required)

serviceInstanceData - (required)

Returns:

ApiResponse<ServiceInstanceData>

Throws:

ApiException - if fails to make API call