Package io.camunda.service

Class ProcessInstanceServices

java.lang.Object

io.camunda.service.ApiServices<ProcessInstanceServices>

io.camunda.service.search.core.SearchQueryService<ProcessInstanceServices,ProcessInstanceQuery,ProcessInstanceEntity>

io.camunda.service.ProcessInstanceServices

public final class ProcessInstanceServices
extends SearchQueryService<ProcessInstanceServices,ProcessInstanceQuery,ProcessInstanceEntity>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ProcessInstanceServices.ProcessInstanceCancelRequest
static final record	ProcessInstanceServices.ProcessInstanceCreateRequest
static final record	ProcessInstanceServices.ProcessInstanceMigrateRequest
static final record	ProcessInstanceServices.ProcessInstanceModifyRequest

Field Summary

Fields inherited from class io.camunda.service.search.core.SearchQueryService

executor

Fields inherited from class io.camunda.service.ApiServices

authentication, brokerClient, searchClient, transformers

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceServices(BrokerClient brokerClient, CamundaSearchClient dataStoreClient)
ProcessInstanceServices(BrokerClient brokerClient, CamundaSearchClient searchClient, ServiceTransformers transformers, Authentication authentication)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ProcessInstanceRecord>	cancelProcessInstance(ProcessInstanceServices.ProcessInstanceCancelRequest request)
CompletableFuture<ProcessInstanceCreationRecord>	createProcessInstance(ProcessInstanceServices.ProcessInstanceCreateRequest request)
CompletableFuture<ProcessInstanceResultRecord>	createProcessInstanceWithResult(ProcessInstanceServices.ProcessInstanceCreateRequest request)
CompletableFuture<ProcessInstanceMigrationRecord>	migrateProcessInstance(ProcessInstanceServices.ProcessInstanceMigrateRequest request)
CompletableFuture<ProcessInstanceModificationRecord>	modifyProcessInstance(ProcessInstanceServices.ProcessInstanceModifyRequest request)
SearchQueryResult<ProcessInstanceEntity>	search(ProcessInstanceQuery query)
SearchQueryResult<ProcessInstanceEntity>	search(Function<ProcessInstanceQuery.Builder,ObjectBuilder<ProcessInstanceQuery>> fn)
ProcessInstanceServices	withAuthentication(Authentication authentication)

Methods inherited from class io.camunda.service.ApiServices

getDocumentOrEmpty, sendBrokerRequest, sendBrokerRequestWithFullResponse, withAuthentication

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessInstanceServices

public ProcessInstanceServices(BrokerClient brokerClient,
 CamundaSearchClient dataStoreClient)

ProcessInstanceServices

public ProcessInstanceServices(BrokerClient brokerClient,
 CamundaSearchClient searchClient,
 ServiceTransformers transformers,
 Authentication authentication)

Method Details

withAuthentication

public ProcessInstanceServices withAuthentication(Authentication authentication)

Specified by:

withAuthentication in class ApiServices<ProcessInstanceServices>

search

public SearchQueryResult<ProcessInstanceEntity> search(ProcessInstanceQuery query)

Specified by:

search in class SearchQueryService<ProcessInstanceServices,ProcessInstanceQuery,ProcessInstanceEntity>

search

public SearchQueryResult<ProcessInstanceEntity> search(Function<ProcessInstanceQuery.Builder,ObjectBuilder<ProcessInstanceQuery>> fn)

createProcessInstance

public CompletableFuture<ProcessInstanceCreationRecord> createProcessInstance(ProcessInstanceServices.ProcessInstanceCreateRequest request)

createProcessInstanceWithResult

public CompletableFuture<ProcessInstanceResultRecord> createProcessInstanceWithResult(ProcessInstanceServices.ProcessInstanceCreateRequest request)

cancelProcessInstance

public CompletableFuture<ProcessInstanceRecord> cancelProcessInstance(ProcessInstanceServices.ProcessInstanceCancelRequest request)

migrateProcessInstance

public CompletableFuture<ProcessInstanceMigrationRecord> migrateProcessInstance(ProcessInstanceServices.ProcessInstanceMigrateRequest request)

modifyProcessInstance

public CompletableFuture<ProcessInstanceModificationRecord> modifyProcessInstance(ProcessInstanceServices.ProcessInstanceModifyRequest request)