Package org.camunda.community.rest.client.api

Class EngineApi

java.lang.Object

org.camunda.community.rest.client.api.EngineApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T13:43:01.451833574Z[Etc/UTC]")
public class EngineApi
extends Object

Constructor Summary

Constructors

Constructor	Description
EngineApi()
EngineApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
List<ProcessEngineDto>	getProcessEngineNames()	Get List Retrieves the names of all process engines available on your platform.
List<ProcessEngineDto>	getProcessEngineNames(Map<String,String> additionalHeaders)	Get List Retrieves the names of all process engines available on your platform.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

EngineApi

public EngineApi()

EngineApi

public EngineApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getProcessEngineNames

public List<ProcessEngineDto> getProcessEngineNames()
                                             throws ApiException

Get List Retrieves the names of all process engines available on your platform. **Note**: You cannot prepend `/engine/{name}` to this method.

Returns:

List<ProcessEngineDto>

Throws:

ApiException - if fails to make API call

getProcessEngineNames

public List<ProcessEngineDto> getProcessEngineNames(Map<String,String> additionalHeaders)
                                             throws ApiException

Get List Retrieves the names of all process engines available on your platform. **Note**: You cannot prepend `/engine/{name}` to this method.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<ProcessEngineDto>

Throws:

ApiException - if fails to make API call