Package io.camunda.client.impl

Class CamundaClientImpl

java.lang.Object

io.camunda.client.impl.CamundaClientImpl

All Implemented Interfaces:

JobClient, CamundaClient, AutoCloseable

public final class CamundaClientImpl
extends Object
implements CamundaClient

Constructor Summary

Constructors

Constructor	Description
CamundaClientImpl(CamundaClientConfiguration configuration)
CamundaClientImpl(CamundaClientConfiguration configuration, io.grpc.ManagedChannel channel)
CamundaClientImpl(CamundaClientConfiguration configuration, io.grpc.ManagedChannel channel, HttpClient httpClient)
CamundaClientImpl(CamundaClientConfiguration configuration, io.grpc.ManagedChannel channel, io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub)
CamundaClientImpl(CamundaClientConfiguration config, io.grpc.ManagedChannel channel, io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub, JobWorkerExecutors executorResource)
CamundaClientImpl(CamundaClientConfiguration config, io.grpc.ManagedChannel channel, io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub, JobWorkerExecutors executorResource, HttpClient httpClient)

Method Summary

Modifier and Type	Method	Description
static io.grpc.ManagedChannel	buildChannel(CamundaClientConfiguration config)
static io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub	buildGatewayStub(io.grpc.ManagedChannel channel, CamundaClientConfiguration config)
void	close()
CamundaClientConfiguration	getConfiguration()
ActivateAdHocSubProcessActivitiesCommandStep1	newActivateAdHocSubProcessActivitiesCommand(String adHocSubProcessInstanceKey)	Command to activate activities within an activated ad-hoc sub-process.
ActivateJobsCommandStep1	newActivateJobsCommand()	Command to activate multiple jobs of a given type.
AgentInstanceGetRequest	newAgentInstanceGetRequest(long agentInstanceKey)	Creates a request to fetch an agent instance by its key.
AgentInstanceHistorySearchRequest	newAgentInstanceHistorySearchRequest(long agentInstanceKey)	Creates a request to search the conversation history of an agent instance.
AgentInstanceSearchRequest	newAgentInstanceSearchRequest()	Creates a request to search for agent instances.
AssignClientToGroupCommandStep1	newAssignClientToGroupCommand()	Command to assign a client to a group.
AssignClientToTenantCommandStep1	newAssignClientToTenantCommand()	Command to assign a client to a tenant.
AssignGroupToTenantCommandStep1	newAssignGroupToTenantCommand()	Command to assign a group to a tenant.
AssignMappingRuleToGroupStep1	newAssignMappingRuleToGroupCommand()	Command to assign a mapping rule to a group.
AssignMappingRuleToTenantCommandStep1	newAssignMappingRuleToTenantCommand()	Command to assign a mapping rule to a tenant.
AssignProcessInstanceBusinessIdCommandStep1	newAssignProcessInstanceBusinessIdCommand(long processInstanceKey)	Command to assign a business id to an already running process instance.
AssignRoleToClientCommandStep1	newAssignRoleToClientCommand()	Command to assign a role to a client.
AssignRoleToGroupCommandStep1	newAssignRoleToGroupCommand()	Command to assign a role to a group.
AssignRoleToMappingRuleCommandStep1	newAssignRoleToMappingRuleCommand()	Command to assign a role to a mapping rule.
AssignRoleToTenantCommandStep1	newAssignRoleToTenantCommand()	Command to assign a role to a tenant.
AssignRoleToUserCommandStep1	newAssignRoleToUserCommand()	Command to assign a role to a user.
AssignUserTaskCommandStep1	newAssignUserTaskCommand(long userTaskKey)	Command to assign a user task.
AssignUserToGroupCommandStep1	newAssignUserToGroupCommand()	Command to assign a user to a group.
AssignUserToTenantCommandStep1	newAssignUserToTenantCommand()	Command to assign a user to a tenant.
AuditLogGetRequest	newAuditLogGetRequest(String auditLogKey)	Request to get an audit log by audit log key.
AuditLogSearchRequest	newAuditLogSearchRequest()	Executes a search request to query audit logs by the audit log key.
AuthorizationGetRequest	newAuthorizationGetRequest(long authorizationKey)	Request to get an authorization by authorization key.
AuthorizationsSearchRequest	newAuthorizationSearchRequest()	Executes a search request to query authorizations.
BatchOperationGetRequest	newBatchOperationGetRequest(String batchOperationKey)	Request to get a single batch operation by batch operation key.
BatchOperationItemSearchRequest	newBatchOperationItemsSearchRequest()	Executes a search request to query batch operation items.
BatchOperationSearchRequest	newBatchOperationSearchRequest()	Executes a search request to query batch operations.
BroadcastSignalCommandStep1	newBroadcastSignalCommand()	Command to broadcast a signal.
CancelBatchOperationStep1	newCancelBatchOperationCommand(String batchOperationKey)	Command to cancel a batch operation
CancelProcessInstanceCommandStep1	newCancelInstanceCommand(long processInstanceKey)	Command to cancel a process instance.
ClientsByGroupSearchRequest	newClientsByGroupSearchRequest(String groupId)	Executes a search request to query clients by group.
ClientsByRoleSearchRequest	newClientsByRoleSearchRequest(String roleId)	Executes a search request to query clients by role.
ClientsByTenantSearchRequest	newClientsByTenantSearchRequest(String tenantId)	Executes a search request to query clients by tenant.
ClusterVariableSearchRequest	newClusterVariableSearchRequest()	Creates a request to search for cluster variables.
CompleteJobCommandStep1	newCompleteCommand(long jobKey)	Command to complete a job.
CompleteJobCommandStep1	newCompleteCommand(ActivatedJob job)	Command to complete a job.
CompleteUserTaskCommandStep1	newCompleteUserTaskCommand(long userTaskKey)	Command to complete a user task.
CorrelatedMessageSubscriptionSearchRequest	newCorrelatedMessageSubscriptionSearchRequest()	Executes a search request to query correlated message subscriptions.
CorrelateMessageCommandStep1	newCorrelateMessageCommand()	Command to correlate a message and wait for it to be correlated against a process instance.
CreateAgentHistoryItemCommandStep1	newCreateAgentHistoryItemCommand(long agentInstanceKey)	Creates a command to append a conversation history item to an agent instance.
CreateAgentInstanceCommandStep1	newCreateAgentInstanceCommand()	Creates a command to create a new agent instance.
CreateAuthorizationCommandStep1	newCreateAuthorizationCommand()	Command to create an authorization
CreateBatchOperationCommandStep1	newCreateBatchOperationCommand()	Command to create a batch operation
CreateDocumentBatchCommandStep1	newCreateDocumentBatchCommand()	Experimental: This method is under development.
CreateDocumentCommandStep1	newCreateDocumentCommand()	Experimental: This method is under development.
CreateDocumentLinkCommandStep1	newCreateDocumentLinkCommand(DocumentReferenceResponse documentReference)	Experimental: This method is under development.
CreateDocumentLinkCommandStep1	newCreateDocumentLinkCommand(String documentId)	Experimental: This method is under development.
CreateGlobalTaskListenerCommandStep1	newCreateGlobalTaskListenerRequest()	Creates a request to create a new global task listener.
CreateGroupCommandStep1	newCreateGroupCommand()	Command to create a group.
CreateProcessInstanceCommandStep1	newCreateInstanceCommand()	Command to create/start a new instance of a process.
CreateMappingRuleCommandStep1	newCreateMappingRuleCommand()	Command to create a mapping rule.
CreateRoleCommandStep1	newCreateRoleCommand()	Command to create a role.
CreateTenantCommandStep1	newCreateTenantCommand()	Command to create a tenant.
CreateUserCommandStep1	newCreateUserCommand()	Command to create a user.
DecisionDefinitionGetRequest	newDecisionDefinitionGetRequest(long decisionDefinitionKey)	Gets a decision definition by key.
DecisionDefinitionGetXmlRequest	newDecisionDefinitionGetXmlRequest(long decisionKey)	Retrieves the XML representation of a decision definition.
DecisionDefinitionSearchRequest	newDecisionDefinitionSearchRequest()	Executes a search request to query decision definitions.
DecisionInstanceGetRequest	newDecisionInstanceGetRequest(String decisionInstanceId)	Retrieves a decision instance by id.
DecisionInstanceSearchRequest	newDecisionInstanceSearchRequest()	Executes a search request to query decision instances.
DecisionRequirementsGetRequest	newDecisionRequirementsGetRequest(long decisionRequirementsKey)	Gets a decision requirements by key.
DecisionRequirementsGetXmlRequest	newDecisionRequirementsGetXmlRequest(long decisionRequirementsKey)	Retrieves the XML representation of a decision requirements.
DecisionRequirementsSearchRequest	newDecisionRequirementsSearchRequest()	Executes a search request to query Decision Requirements.
DeleteAuthorizationCommandStep1	newDeleteAuthorizationCommand(long authorizationKey)	Command to delete an authorization
DeleteDecisionInstanceCommandStep1	newDeleteDecisionInstanceCommand(long decisionInstanceKey)	Command to delete a decision instance history.
DeleteDocumentCommandStep1	newDeleteDocumentCommand(DocumentReferenceResponse documentReference)	Experimental: This method is under development.
DeleteDocumentCommandStep1	newDeleteDocumentCommand(String documentId)	Experimental: This method is under development.
DeleteGlobalTaskListenerCommandStep1	newDeleteGlobalTaskListenerRequest(String id)	Creates a request to delete a global task listener.
DeleteGroupCommandStep1	newDeleteGroupCommand(String groupId)	Command to delete a group.
DeleteMappingRuleCommandStep1	newDeleteMappingRuleCommand(String mappingRuleId)	Command to delete a mapping rule.
DeleteProcessInstanceCommandStep1	newDeleteProcessInstanceCommand(long processInstanceKey)	Command to delete a process instance history.
DeleteResourceCommandStep1	newDeleteResourceCommand(long resourceKey)	Command to delete a resource.
DeleteRoleCommandStep1	newDeleteRoleCommand(String roleId)	Command to delete a role by role ID.
DeleteTenantCommandStep1	newDeleteTenantCommand(String tenantId)	Command to delete a tenant.
DeleteUserCommandStep1	newDeleteUserCommand(String username)	Command to delete a user by username
DeployProcessCommandStep1	newDeployCommand()	Command to deploy new processes.
DeployResourceCommandStep1	newDeployResourceCommand()	Command to deploy new resources, i.e.
DocumentContentGetRequest	newDocumentContentGetRequest(DocumentReferenceResponse documentReference)	Experimental: This method is under development.
DocumentContentGetRequest	newDocumentContentGetRequest(String documentId)	Experimental: This method is under development.
ElementInstanceGetRequest	newElementInstanceGetRequest(long elementInstanceKey)	Gets a element instance by key.
ElementInstanceSearchRequest	newElementInstanceSearchRequest()	Executes a search request to query element instances.
ElementInstanceWaitStateSearchRequest	newElementInstanceWaitStateSearchRequest()	Executes a search request to query element instance wait states.
EvaluateConditionalCommandStep1	newEvaluateConditionalCommand()	Command to evaluate root-level conditional start events for process definitions.
EvaluateDecisionCommandStep1	newEvaluateDecisionCommand()	Command to evaluate a decision.
EvaluateExpressionCommandStep1	newEvaluateExpressionCommand()	Command to evaluate an expression.
FailJobCommandStep1	newFailCommand(long jobKey)	Command to mark a job as failed.
FailJobCommandStep1	newFailCommand(ActivatedJob job)	Command to mark a job as failed.
FormGetRequest	newFormGetRequest(long formKey)	Gets a Form by key.
GlobalJobStatisticsRequest	newGlobalJobStatisticsRequest(OffsetDateTime from, OffsetDateTime to)	Executes a request to query global job statistics.
GloballyScopedClusterVariableCreationCommandStep1	newGloballyScopedClusterVariableCreateRequest()	Creates a request to create a new globally-scoped cluster variable.
GloballyScopedClusterVariableDeletionCommandStep1	newGloballyScopedClusterVariableDeleteRequest()	Creates a request to delete a globally-scoped cluster variable.
GloballyScopedClusterVariableGetRequest	newGloballyScopedClusterVariableGetRequest()	Creates a request to fetch a globally-scoped cluster variable by name.
GloballyScopedClusterVariableUpdateCommandStep1	newGloballyScopedClusterVariableUpdateRequest()	Creates a request to update a globally-scoped cluster variable.
GlobalTaskListenerGetRequest	newGlobalTaskListenerGetRequest(String id)	Creates a request to fetch a global task listener by id.
GlobalTaskListenerSearchRequest	newGlobalTaskListenerSearchRequest()	Creates a request to search for global task listeners.
GroupGetRequest	newGroupGetRequest(String groupId)	Request to get a group by group ID.
GroupsByRoleSearchRequest	newGroupsByRoleSearchRequest(String roleId)	Executes a search request to query groups by role.
GroupsByTenantSearchRequest	newGroupsByTenantSearchRequest(String tenantId)	Executes a search request to query groups by tenant.
GroupsSearchRequest	newGroupsSearchRequest()	Executes a search request to query groups.
IncidentGetRequest	newIncidentGetRequest(long incidentKey)	Gets an incident by key.
IncidentProcessInstanceStatisticsByDefinitionRequest	newIncidentProcessInstanceStatisticsByDefinitionRequest(int errorHashCode)	Executes a statistics request that returns counts of active process instances with active incidents, grouped by process definition.
IncidentProcessInstanceStatisticsByErrorRequest	newIncidentProcessInstanceStatisticsByErrorRequest()	Retrieves statistics about active process instances that currently have active incidents, grouped by incident error hash code.
IncidentsByElementInstanceSearchRequest	newIncidentsByElementInstanceSearchRequest(long elementInstanceKey)	Executes a search request to query incidents by element instance key.
IncidentsByProcessInstanceSearchRequest	newIncidentsByProcessInstanceSearchRequest(long processInstanceKey)	Executes a search request to query incidents by process instance key.
IncidentSearchRequest	newIncidentSearchRequest()	Executes a search request to query incidents.
JobErrorStatisticsRequest	newJobErrorStatisticsRequest(OffsetDateTime from, OffsetDateTime to, String jobType)	Executes a request to query per-error job metrics for a specific job type.
JobSearchRequest	newJobSearchRequest()	Executes a search request to query jobs.
JobTimeSeriesStatisticsRequest	newJobTimeSeriesStatisticsRequest(OffsetDateTime from, OffsetDateTime to, String jobType)	Executes a request to query time-bucketed job metrics for a specific job type.
JobTypeStatisticsRequest	newJobTypeStatisticsRequest(OffsetDateTime from, OffsetDateTime to)	Executes a request to query job statistics grouped by job type.
JobWorkerStatisticsRequest	newJobWorkerStatisticsRequest(OffsetDateTime from, OffsetDateTime to, String jobType)	Executes a request to query job statistics grouped by worker for a specific job type.
MappingRuleGetRequest	newMappingRuleGetRequest(String mappingRuleId)	Request to get a mapping rule by mapping rule ID.
MappingRulesByGroupSearchRequest	newMappingRulesByGroupSearchRequest(String groupId)	Executes a search request to query mapping rules by group.
MappingRulesByRoleSearchRequest	newMappingRulesByRoleSearchRequest(String roleId)	Executes a search request to query mapping rules by role.
MappingRulesByTenantSearchRequest	newMappingRulesByTenantSearchRequest(String tenantId)	Executes a search request to query mapping rules by tenant.
MappingRulesSearchRequest	newMappingRulesSearchRequest()	Executes a search request to query mapping rules.
MessageSubscriptionSearchRequest	newMessageSubscriptionSearchRequest()	Executes a search request to query message subscriptions.
MigrateProcessInstanceCommandStep1	newMigrateProcessInstanceCommand(long processInstanceKey)	Command to migrate a process instance to a different process definition.
ModifyProcessInstanceCommandStep1	newModifyProcessInstanceCommand(long processInstanceKey)	Command to modify a process instance.
PinClockCommandStep1	newPinClockCommand()	Command to pin the Zeebe engine's internal clock to a specific time.
ProcessDefinitionElementStatisticsRequest	newProcessDefinitionElementStatisticsRequest(long processDefinitionKey)	Executes a search request to query process definition element statistics.
ProcessDefinitionGetFormRequest	newProcessDefinitionGetFormRequest(long processDefinitionKey)	Retrieves the Form of a process definition.
ProcessDefinitionGetRequest	newProcessDefinitionGetRequest(long processDefinitionKey)	Gets a process definition by key.
ProcessDefinitionGetXmlRequest	newProcessDefinitionGetXmlRequest(long processDefinitionKey)	Retrieves the XML representation of a process definition.
ProcessDefinitionInstanceStatisticsRequest	newProcessDefinitionInstanceStatisticsRequest()	Get statistics about process instances, grouped by process definition and tenant.
ProcessDefinitionInstanceVersionStatisticsRequest	newProcessDefinitionInstanceVersionStatisticsRequest(String processDefinitionId)	Get statistics about process instances, grouped by version for a given process definition.
ProcessDefinitionMessageSubscriptionStatisticsRequest	newProcessDefinitionMessageSubscriptionStatisticsRequest()	Executes a search request to query process definition message subscription statistics.
ProcessDefinitionSearchRequest	newProcessDefinitionSearchRequest()	Executes a search request to query process definitions.
ProcessInstanceElementStatisticsRequest	newProcessInstanceElementStatisticsRequest(long processInstanceKey)	Executes a search request to query process instance element statistics.
ProcessInstanceGetCallHierarchyRequest	newProcessInstanceGetCallHierarchyRequest(Long processInstanceKey)	Retrieves the call hierarchy for a given process instance by its key.
ProcessInstanceGetRequest	newProcessInstanceGetRequest(long processInstanceKey)	Retrieves a process instance by key.
ProcessInstanceSearchRequest	newProcessInstanceSearchRequest()	Executes a search request to query process instances.
ProcessInstanceSequenceFlowsRequest	newProcessInstanceSequenceFlowsRequest(long processInstanceKey)	Executes a search request to query process instance sequence flows.
ProcessInstanceWaitStateStatisticsRequest	newProcessInstanceWaitStateStatisticsRequest(long processInstanceKey)	Executes a request to query process instance wait state statistics, grouped by element id.
PublishMessageCommandStep1	newPublishMessageCommand()	Command to publish a message which can be correlated to a process instance.
ResetClockCommandStep1	newResetClockCommand()	Command to reset the Zeebe engine's internal clock to the system time.
ResolveIncidentCommandStep1	newResolveIncidentCommand(long incidentKey)	Command to resolve an existing incident.
ResolveProcessInstanceIncidentsCommandStep1	newResolveProcessInstanceIncidentsCommand(long processInstanceKey)	Command to resolve multiple existing incidents for one process instance.
ResourceContentGetRequest	newResourceContentBinaryGetRequest(long resourceKey)	Retrieves a resource content as binary by key.
ResourceContentGetRequest	newResourceContentGetRequest(long resourceKey)	Retrieves a resource content by key.
ResourceGetRequest	newResourceGetRequest(long resourceKey)	Retrieves a resource by key.
ResourceSearchRequest	newResourceSearchRequest()	Executes a search request to query deployed resources.
ResumeBatchOperationStep1	newResumeBatchOperationCommand(String batchOperationKey)	Command to resume a batch operation
ResumeProcessInstanceCommandStep1	newResumeProcessInstanceCommand(long processInstanceKey)	Command to resume a process instance.
RoleGetRequest	newRoleGetRequest(String roleId)	Request to get a role by role ID.
RolesByGroupSearchRequest	newRolesByGroupSearchRequest(String groupId)	Executes a search request to query roles by group.
RolesByTenantSearchRequest	newRolesByTenantSearchRequest(String tenantId)	Executes a search request to query roles assigned to a specific tenant.
RolesSearchRequest	newRolesSearchRequest()	Executes a search request to query roles.
SetVariablesCommandStep1	newSetVariablesCommand(long elementInstanceKey)	Command to set and/or update the variables of a given flow element (e.g. process instance, task, etc.)
StatusRequestStep1	newStatusRequest()	Request the current cluster status.
StreamJobsCommandStep1	newStreamJobsCommand()	Activates and streams jobs of a specific type.
SuspendBatchOperationStep1	newSuspendBatchOperationCommand(String batchOperationKey)	Command to suspend a batch operation
SuspendProcessInstanceCommandStep1	newSuspendProcessInstanceCommand(long processInstanceKey)	Command to suspend a process instance.
TenantGetRequest	newTenantGetRequest(String tenantId)	Request to get a tenant by tenant ID.
TenantScopedClusterVariableCreationCommandStep1	newTenantScopedClusterVariableCreateRequest(String tenantId)	Creates a request to create a new tenant-scoped cluster variable.
TenantScopedClusterVariableDeletionCommandStep1	newTenantScopedClusterVariableDeleteRequest(String tenantId)	Creates a request to delete a tenant-scoped cluster variable.
TenantScopedClusterVariableGetRequest	newTenantScopedClusterVariableGetRequest(String tenantId)	Creates a request to fetch a tenant-scoped cluster variable by name.
TenantScopedClusterVariableUpdateCommandStep1	newTenantScopedClusterVariableUpdateRequest(String tenantId)	Creates a request to update a tenant-scoped cluster variable.
TenantsSearchRequest	newTenantsSearchRequest()	Executes a search request to query tenants.
ThrowErrorCommandStep1	newThrowErrorCommand(long jobKey)	Command to report a business error (i.e. non-technical) that occurs while processing a job.
ThrowErrorCommandStep1	newThrowErrorCommand(ActivatedJob job)	Command to report a business error (i.e. non-technical) that occurs while processing a job.
TopologyRequestStep1	newTopologyRequest()	Request the current cluster topology.
UnassignClientFromGroupCommandStep1	newUnassignClientFromGroupCommand()	Command to unassign a client from a group.
UnassignClientFromTenantCommandStep1	newUnassignClientFromTenantCommand()	Command to unassign a client from a tenant.
UnassignGroupFromTenantCommandStep1	newUnassignGroupFromTenantCommand()	Command to unassign a group from a tenant.
UnassignMappingRuleFromGroupStep1	newUnassignMappingRuleFromGroupCommand()	Command to unassign a mapping rule from a group.
UnassignMappingRuleFromTenantCommandStep1	newUnassignMappingRuleFromTenantCommand()	Command to unassign a mapping rule from a tenant.
UnassignRoleFromClientCommandStep1	newUnassignRoleFromClientCommand()	Command to unassign a role from a client.
UnassignRoleFromGroupCommandStep1	newUnassignRoleFromGroupCommand()	Command to unassign a role from a group.
UnassignRoleFromMappingRuleCommandStep1	newUnassignRoleFromMappingRuleCommand()	Command to unassign a role from a mapping rule.
UnassignRoleFromTenantCommandStep1	newUnassignRoleFromTenantCommand()	Command to unassign a role from a tenant.
UnassignRoleFromUserCommandStep1	newUnassignRoleFromUserCommand()	Command to unassign a role from a user.
UnassignUserFromGroupCommandStep1	newUnassignUserFromGroupCommand()	Command to unassign a user from a group.
UnassignUserFromTenantCommandStep1	newUnassignUserFromTenantCommand()	Command to unassign a user from a tenant.
UnassignUserTaskCommandStep1	newUnassignUserTaskCommand(long userTaskKey)	Command to unassign a user task.
UpdateAgentInstanceCommandStep1	newUpdateAgentInstanceCommand(long agentInstanceKey)	Creates a command to update an existing agent instance.
UpdateAuthorizationCommandStep1	newUpdateAuthorizationCommand(long authorizationKey)	Command to update an authorization
UpdateGlobalTaskListenerCommandStep1	newUpdateGlobalTaskListenerRequest(String id)	Creates a request to update an existing global task listener.
UpdateGroupCommandStep1	newUpdateGroupCommand(String groupId)	Command to update a group.
UpdateJobCommandStep1	newUpdateJobCommand(long jobKey)	Command to update the retries and/or the timeout of a job.
UpdateJobCommandStep1	newUpdateJobCommand(ActivatedJob job)	Command to update the retries and/or the timeout of a job.
UpdateJobPriorityCommandStep1	newUpdateJobPriorityCommand(long jobKey)	Command to update the priority of a job.
UpdateJobPriorityCommandStep1	newUpdateJobPriorityCommand(ActivatedJob job)	Command to update the priority of a job.
UpdateMappingRuleCommandStep1	newUpdateMappingRuleCommand(String mappingRuleId)	Command to update a mapping rule.
UpdateRetriesJobCommandStep1	newUpdateRetriesCommand(long jobKey)	Command to update the retries of a job.
UpdateRetriesJobCommandStep1	newUpdateRetriesCommand(ActivatedJob job)	Command to update the retries of a job.
UpdateRoleCommandStep1	newUpdateRoleCommand(String roleId)	Command to update a role.
UpdateTenantCommandStep1	newUpdateTenantCommand(String tenantId)	Creates a command to update the name of an existing tenant.
UpdateTimeoutJobCommandStep1	newUpdateTimeoutCommand(long jobKey)	Command to update the timeout of a job.
UpdateTimeoutJobCommandStep1	newUpdateTimeoutCommand(ActivatedJob job)	Command to update the timeout of a job.
UpdateUserCommandStep1	newUpdateUserCommand(String username)	Command to update a user.
UpdateUserTaskCommandStep1	newUpdateUserTaskCommand(long userTaskKey)	Command to update a user task.
UsageMetricsStatisticsRequest	newUsageMetricsRequest(OffsetDateTime startTime, OffsetDateTime endTime)	Executes a search request to query usage metrics statistics.
UserGetRequest	newUserGetRequest(String username)	Request to get a user by username.
UsersByGroupSearchRequest	newUsersByGroupSearchRequest(String groupId)	Executes a search request to query users by group.
UsersByRoleSearchRequest	newUsersByRoleSearchRequest(String roleId)	Executes a search request to query users by role.
UsersByTenantSearchRequest	newUsersByTenantSearchRequest(String tenantId)	Executes a search request to query users assigned to a tenant.
UsersSearchRequest	newUsersSearchRequest()	Executes a search request to query users.
UserTaskAuditLogSearchRequest	newUserTaskAuditLogSearchRequest(long userTaskKey)	Executes a search request to query audit logs related to a user task.
UserTaskEffectiveVariableSearchRequest	newUserTaskEffectiveVariableSearchRequest(long userTaskKey)	Executes a search request to query effective variables related to a user task.
UserTaskGetFormRequest	newUserTaskGetFormRequest(long userTaskKey)	Gets a user task form by key.
UserTaskGetRequest	newUserTaskGetRequest(long userTaskKey)	Gets a User Task by key.
UserTaskSearchRequest	newUserTaskSearchRequest()	Executes a search request to query user tasks.
UserTaskVariableSearchRequest	newUserTaskVariableSearchRequest(long userTaskKey)	Executes a search request to query variables related to a user task.
VariableGetRequest	newVariableGetRequest(long variableKey)	Gets a variable by key.
VariableSearchRequest	newVariableSearchRequest()	Executes a search request to query variables.
JobWorkerBuilderStep1	newWorker()	Registers a new job worker for jobs of a given type.

Methods inherited from class java.lang.Object

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

Constructor Details

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration configuration)

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration configuration,
 io.grpc.ManagedChannel channel)

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration configuration,
 io.grpc.ManagedChannel channel,
 HttpClient httpClient)

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration configuration,
 io.grpc.ManagedChannel channel,
 io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub)

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration config,
 io.grpc.ManagedChannel channel,
 io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub,
 JobWorkerExecutors executorResource)

CamundaClientImpl

public CamundaClientImpl(CamundaClientConfiguration config,
 io.grpc.ManagedChannel channel,
 io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub gatewayStub,
 JobWorkerExecutors executorResource,
 HttpClient httpClient)

Method Details

buildChannel

public static io.grpc.ManagedChannel buildChannel(CamundaClientConfiguration config)

buildGatewayStub

public static io.camunda.zeebe.gateway.protocol.GatewayGrpc.GatewayStub buildGatewayStub(io.grpc.ManagedChannel channel,
 CamundaClientConfiguration config)

newTopologyRequest

public TopologyRequestStep1 newTopologyRequest()

Description copied from interface: CamundaClient

Request the current cluster topology. Can be used to inspect which brokers are available at which endpoint and which broker is the leader of which partition.

 List<BrokerInfo> brokers = camundaClient
  .newTopologyRequest()
  .send()
  .join()
  .getBrokers();

  InetSocketAddress address = broker.getSocketAddress();

  List<PartitionInfo> partitions = broker.getPartitions();
 

Specified by:

newTopologyRequest in interface CamundaClient

Returns:

the request where you must call send()

newStatusRequest

public StatusRequestStep1 newStatusRequest()

Description copied from interface: CamundaClient

Request the current cluster status. Can be used to check if the cluster is healthy (has at least one partition with a healthy leader).

 boolean isHealthy = camundaClient
  .newStatusRequest()
  .send()
  .join()
  .isHealthy();
 

Specified by:

newStatusRequest in interface CamundaClient

Returns:

the request where you must call send()

getConfiguration

public CamundaClientConfiguration getConfiguration()

Specified by:

getConfiguration in interface CamundaClient

Returns:

the client's configuration

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface CamundaClient

newDeployCommand

public DeployProcessCommandStep1 newDeployCommand()

Description copied from interface: CamundaClient

Command to deploy new processes.

 camundaClient
  .newDeployCommand()
  .addResourceFile("~/wf/process1.bpmn")
  .addResourceFile("~/wf/process2.bpmn")
  .send();
 

Specified by:

newDeployCommand in interface CamundaClient

Returns:

a builder for the command

newDeployResourceCommand

public DeployResourceCommandStep1 newDeployResourceCommand()

Description copied from interface: CamundaClient

Command to deploy new resources, i.e. BPMN process models and DMN decision models.

 camundaClient
  .newDeployCommand()
  .addResourceFile("~/wf/process1.bpmn")
  .addResourceFile("~/wf/process2.bpmn")
  .addResourceFile("~/dmn/decision.dmn")
  .send();
 

Specified by:

newDeployResourceCommand in interface CamundaClient

Returns:

a builder for the command

newCreateInstanceCommand

public CreateProcessInstanceCommandStep1 newCreateInstanceCommand()

Description copied from interface: CamundaClient

Command to create/start a new instance of a process.

 camundaClient
  .newCreateInstanceCommand()
  .bpmnProcessId("my-process")
  .latestVersion()
  .variables(json)
  .send();
 

Specified by:

newCreateInstanceCommand in interface CamundaClient

Returns:

a builder for the command

newModifyProcessInstanceCommand

public ModifyProcessInstanceCommandStep1 newModifyProcessInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to modify a process instance.

   camundaClient
    .newModifyProcessInstanceCommand(processInstanceKey)
    .activateElement("element1")
    .and()
    .activateElement("element2")
    .withVariables(globalScopedVariables)
    .withVariables(localScopedVariables, "element2")
    .and()
    .terminateElement("element3")
    .send();
 

Specified by:

newModifyProcessInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which identifies the corresponding process instance

Returns:

a builder for the command

newMigrateProcessInstanceCommand

public MigrateProcessInstanceCommandStep1 newMigrateProcessInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to migrate a process instance to a different process definition.

The migration command contains a migration plan. Migration plan contains targetProcessDefinitionKey to indicate which process definition to use for the migration. Mapping instructions for the migration describe how to map elements from the source process definition to the target process definition.

For example, let's consider we want to migrate process instance with key 1, target process definition key 2, a source process definition with a service task with id "task1" and the target process definition with a service task with id "task2". The migration command could be:

 {
  "processInstanceKey": 1,
  "migrationPlan": {
   "targetProcessDefinitionKey": 2,
   "mappingInstructions": [
    {
     "sourceElementId": "task1",
     "targetElementId": "task2"
    }
   ]
  }
 }
 

 camundaClient
  .newMigrateProcessInstanceCommand(1L)
  .migrationPlan(2L)
  .addMappingInstruction("element1", "element2")
  .addMappingInstruction("element3", "element4")
  .send();
 

 final MigrationPlan migrationPlan =
         MigrationPlan.newBuilder()
             .withTargetProcessDefinitionKey(2L)
             .addMappingInstruction("element1", "element2")
             .addMappingInstruction("element3", "element4")
             .build();
 camundaClient
  .newMigrateProcessInstanceCommand(1L)
  .migrationPlan(migrationPlan)
  .send();
 

Specified by:

newMigrateProcessInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which refers to the process instance to migrate

Returns:

a builder for the command

newAssignProcessInstanceBusinessIdCommand

public AssignProcessInstanceBusinessIdCommandStep1 newAssignProcessInstanceBusinessIdCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to assign a business id to an already running process instance.

This allows attaching a business id to a process instance that was started without one. The assignment is rejected if the instance already has a different business id, if it is a child instance created by a call activity, or if business id uniqueness is enabled for its process definition.

 camundaClient
  .newAssignProcessInstanceBusinessIdCommand(processInstanceKey)
  .businessId("order-4711")
  .send();
 

Specified by:

newAssignProcessInstanceBusinessIdCommand in interface CamundaClient

Parameters:

processInstanceKey - the key of the process instance to assign the business id to

Returns:

a builder for the command

newCancelInstanceCommand

public CancelProcessInstanceCommandStep1 newCancelInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to cancel a process instance.

 camundaClient
  .newCancelInstanceCommand(processInstanceKey)
  .send();
 

Specified by:

newCancelInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which identifies the corresponding process instance

Returns:

a builder for the command

newSuspendProcessInstanceCommand

public SuspendProcessInstanceCommandStep1 newSuspendProcessInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to suspend a process instance.

 camundaClient
  .newSuspendProcessInstanceCommand(processInstanceKey)
  .send();
 

Specified by:

newSuspendProcessInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which identifies the corresponding process instance

Returns:

a builder for the command

newResumeProcessInstanceCommand

public ResumeProcessInstanceCommandStep1 newResumeProcessInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to resume a process instance.

 camundaClient
  .newResumeProcessInstanceCommand(processInstanceKey)
  .send();
 

Specified by:

newResumeProcessInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which identifies the corresponding process instance

Returns:

a builder for the command

newDeleteProcessInstanceCommand

public DeleteProcessInstanceCommandStep1 newDeleteProcessInstanceCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to delete a process instance history.

 camundaClient
  .newDeleteProcessInstanceCommand(processInstanceKey)
  .send();
 

Specified by:

newDeleteProcessInstanceCommand in interface CamundaClient

Parameters:

processInstanceKey - the key which identifies the corresponding process instance

Returns:

a builder for the command

newSetVariablesCommand

public SetVariablesCommandStep1 newSetVariablesCommand(long elementInstanceKey)

Description copied from interface: CamundaClient

Command to set and/or update the variables of a given flow element (e.g. process instance, task, etc.)

 camundaClient
  .newSetVariablesCommand(elementInstanceKey)
  .variables(json)
  .send();
 

Specified by:

newSetVariablesCommand in interface CamundaClient

Parameters:

elementInstanceKey - the key of the element instance to set/update the variables for

Returns:

a builder for the command

newEvaluateDecisionCommand

public EvaluateDecisionCommandStep1 newEvaluateDecisionCommand()

Description copied from interface: CamundaClient

Command to evaluate a decision.

 camundaClient
  .newEvaluateDecisionCommand()
  .decisionKey("my-decision")
  .variables(json)
  .send();
 

Specified by:

newEvaluateDecisionCommand in interface CamundaClient

Returns:

a builder for the command

newPublishMessageCommand

public PublishMessageCommandStep1 newPublishMessageCommand()

Description copied from interface: CamundaClient

Command to publish a message which can be correlated to a process instance.

 camundaClient
  .newPublishMessageCommand()
  .messageName("order canceled")
  .correlationKey(orderId)
  .variables(json)
  .send();
 

Specified by:

newPublishMessageCommand in interface CamundaClient

Returns:

a builder for the command

newCorrelateMessageCommand

public CorrelateMessageCommandStep1 newCorrelateMessageCommand()

Description copied from interface: CamundaClient

Command to correlate a message and wait for it to be correlated against a process instance.

 camundaClient
  .newCorrelateMessageCommand()
  .messageName("order canceled")
  .correlationKey(orderId)
  .variables(json)
  .tenantId("tenant")
  .send();
 

Specified by:

newCorrelateMessageCommand in interface CamundaClient

Returns:

a builder for the command

newBroadcastSignalCommand

public BroadcastSignalCommandStep1 newBroadcastSignalCommand()

Description copied from interface: CamundaClient

Command to broadcast a signal.

 camundaClient
  .newBroadcastSignalCommand()
  .signalName("signal")
  .variables(json)
  .send();
 

Specified by:

newBroadcastSignalCommand in interface CamundaClient

Returns:

a builder for the command

newResolveIncidentCommand

public ResolveIncidentCommandStep1 newResolveIncidentCommand(long incidentKey)

Description copied from interface: CamundaClient

Command to resolve an existing incident.

 camundaClient
  .newResolveIncidentCommand(incidentKey)
  .send();
 

Specified by:

newResolveIncidentCommand in interface CamundaClient

Parameters:

incidentKey - the key of the corresponding incident

Returns:

the builder for the command

newResolveProcessInstanceIncidentsCommand

public ResolveProcessInstanceIncidentsCommandStep1 newResolveProcessInstanceIncidentsCommand(long processInstanceKey)

Description copied from interface: CamundaClient

Command to resolve multiple existing incidents for one process instance.

 camundaClient
  .newResolveProcessInstanceIncidentsCommand(processInstanceKey)
  .send();
 

Specified by:

newResolveProcessInstanceIncidentsCommand in interface CamundaClient

Parameters:

processInstanceKey - the key of the process instance to resolve incidents for

Returns:

the builder for the command

newUpdateRetriesCommand

public UpdateRetriesJobCommandStep1 newUpdateRetriesCommand(long jobKey)

Description copied from interface: CamundaClient

Command to update the retries of a job.

 long jobKey = ..;

 camundaClient
  .newUpdateRetriesCommand(jobKey)
  .retries(3)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job worker. This will not close a related incident, which still has to be marked as resolved with newResolveIncidentCommand(long incidentKey) .

Specified by:

newUpdateRetriesCommand in interface CamundaClient

Parameters:

jobKey - the key of the job to update

Returns:

a builder for the command

newUpdateRetriesCommand

public UpdateRetriesJobCommandStep1 newUpdateRetriesCommand(ActivatedJob job)

Description copied from interface: CamundaClient

Command to update the retries of a job.

 ActivatedJob job= ..;

 camundaClient
  .newUpdateRetriesCommand(job)
  .retries(3)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job worker. This will not close a related incident, which still has to be marked as resolved with newResolveIncidentCommand(long incidentKey) .

Specified by:

newUpdateRetriesCommand in interface CamundaClient

Parameters:

job - the activated job

Returns:

a builder for the command

newUpdateTimeoutCommand

public UpdateTimeoutJobCommandStep1 newUpdateTimeoutCommand(long jobKey)

Description copied from interface: CamundaClient

Command to update the timeout of a job.

 long jobKey = ..;

 camundaClient
  .newUpdateTimeoutCommand(jobKey)
  .timeout(100)
  .send();
 

Timeout value in millis is used to calculate a new job deadline. This will happen when the command to update the timeline is processed. The timeout value will be added to the current time then.

Specified by:

newUpdateTimeoutCommand in interface CamundaClient

Parameters:

jobKey - the key of the job to update

Returns:

a builder for the command

newUpdateTimeoutCommand

public UpdateTimeoutJobCommandStep1 newUpdateTimeoutCommand(ActivatedJob job)

Description copied from interface: CamundaClient

Command to update the timeout of a job.

 ActivatedJob job= ..;

 camundaClient
  .newUpdateTimeoutCommand(job)
  .timeout(100)
  .send();
 

Timeout value in millis is used to calculate a new job deadline. This will happen when the command to update the timeline is processed. The timeout value will be added to the current time then.

Specified by:

newUpdateTimeoutCommand in interface CamundaClient

Parameters:

job - the activated job

Returns:

a builder for the command

newUpdateJobPriorityCommand

public UpdateJobPriorityCommandStep1 newUpdateJobPriorityCommand(long jobKey)

Description copied from interface: CamundaClient

Command to update the priority of a job.

 long jobKey = ..;

 camundaClient
  .newUpdateJobPriorityCommand(jobKey)
  .priority(5)
  .send();
 

Specified by:

newUpdateJobPriorityCommand in interface CamundaClient

Parameters:

jobKey - the key of the job to update

Returns:

a builder for the command

newUpdateJobPriorityCommand

public UpdateJobPriorityCommandStep1 newUpdateJobPriorityCommand(ActivatedJob job)

Description copied from interface: CamundaClient

Command to update the priority of a job.

 ActivatedJob job= ..;

 camundaClient
  .newUpdateJobPriorityCommand(job)
  .priority(5)
  .send();
 

Specified by:

newUpdateJobPriorityCommand in interface CamundaClient

Parameters:

job - the activated job

Returns:

a builder for the command

newWorker

public JobWorkerBuilderStep1 newWorker()

Description copied from interface: CamundaClient

Registers a new job worker for jobs of a given type.

After registration, the broker activates available jobs and assigns them to this worker. It then publishes them to the client. The given worker is called for every received job, works on them and eventually completes them.

 JobWorker worker = camundaClient
  .newWorker()
  .jobType("payment")
  .handler(paymentHandler)
  .open();

 ...
 worker.close();
 

Example JobHandler implementation:

 public final class PaymentHandler implements JobHandler
 {
   @Override
   public void handle(JobClient client, JobEvent jobEvent)
   {
     String json = jobEvent.getVariables();
     // modify variables

     client
      .newCompleteCommand()
      .event(jobEvent)
      .variables(json)
      .send();
   }
 };
 

Specified by:

newWorker in interface CamundaClient

Returns:

a builder for the worker registration

newDeleteResourceCommand

public DeleteResourceCommandStep1 newDeleteResourceCommand(long resourceKey)

Description copied from interface: CamundaClient

Command to delete a resource.

 camundaClient
  .newDeleteResourceCommand(resourceKey)
  .send();
 

Specified by:

newDeleteResourceCommand in interface CamundaClient

Parameters:

resourceKey - the key of the resource

Returns:

the builder for the command

newCompleteUserTaskCommand

public CompleteUserTaskCommandStep1 newCompleteUserTaskCommand(long userTaskKey)

Description copied from interface: CamundaClient

Command to complete a user task.

 long userTaskKey = ..;

 camundaClient
  .newCompleteUserTaskCommand(userTaskKey)
  .variables(map)
  .send();
 

If the user task is linked to a process instance then this command will complete the related activity and continue the flow.

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newCompleteUserTaskCommand in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the command

newAssignUserTaskCommand

public AssignUserTaskCommandStep1 newAssignUserTaskCommand(long userTaskKey)

Description copied from interface: CamundaClient

Command to assign a user task.

 long userTaskKey = ..;

 camundaClient
  .newAssignUserTaskCommand(userTaskKey)
  .assignee(newAssignee)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignUserTaskCommand in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the command

newUpdateUserTaskCommand

public UpdateUserTaskCommandStep1 newUpdateUserTaskCommand(long userTaskKey)

Description copied from interface: CamundaClient

Command to update a user task.

 long userTaskKey = ..;

 camundaClient
  .newUpdateUserTaskCommand(userTaskKey)
  .candidateGroups(newCandidateGroups)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUpdateUserTaskCommand in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the command

newUnassignUserTaskCommand

public UnassignUserTaskCommandStep1 newUnassignUserTaskCommand(long userTaskKey)

Description copied from interface: CamundaClient

Command to unassign a user task.

 long userTaskKey = ..;

 camundaClient
  .newUnassignUserTaskCommand(userTaskKey)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignUserTaskCommand in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the command

newUpdateJobCommand

public UpdateJobCommandStep1 newUpdateJobCommand(long jobKey)

Description copied from interface: CamundaClient

Command to update the retries and/or the timeout of a job.

 JobChangeset changeset= ..;

 camundaClient
  .newUpdateCommand(jobKey)
  .update(changeset)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job worker. This will not close a related incident, which still has to be marked as resolved with newResolveIncidentCommand(long incidentKey) .

Timeout value in millis is used to calculate a new job deadline. This will happen when the command to update the timeline is processed. The timeout value will be added to the current time then.

Specified by:

newUpdateJobCommand in interface CamundaClient

Parameters:

jobKey - the key of the job to update

Returns:

a builder for the command

newUpdateJobCommand

public UpdateJobCommandStep1 newUpdateJobCommand(ActivatedJob job)

Description copied from interface: CamundaClient

Command to update the retries and/or the timeout of a job.

 ActivatedJob job= ..;
 JobChangeset changeset= ..;

 camundaClient
  .newUpdateCommand(job)
  .update(changeset)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job worker. This will not close a related incident, which still has to be marked as resolved with newResolveIncidentCommand(long incidentKey) .

Timeout value in millis is used to calculate a new job deadline. This will happen when the command to update the timeline is processed. The timeout value will be added to the current time then.

Specified by:

newUpdateJobCommand in interface CamundaClient

Parameters:

job - the activated job

Returns:

a builder for the command

newPinClockCommand

public PinClockCommandStep1 newPinClockCommand()

Description copied from interface: CamundaClient

Command to pin the Zeebe engine's internal clock to a specific time.

This method initiates a command to pin the clock to a specified time. You can specify the time using either an epoch timestamp in milliseconds or an Instant object.

Once pinned, the clock will remain at the specified time and will not advance until another pin or reset command is issued. This is useful for scenarios where you need to simulate process execution at a specific point in time.

Example usage:

 final long pinnedTime = 1742461285000L; // Thu, Mar 20, 2025 09:01:25 GMT+0000
 camundaClient
  .newPinClockCommand()
  .time(pinnedTime)
  .send();

 final Instant futureInstant = Instant.now().plus(Duration.ofDays(7));
 camundaClient
  .newPinClockCommand()
  .time(futureInstant)
  .send();
 

The command is marked as experimental and may undergo changes or improvements in future releases.

Specified by:

newPinClockCommand in interface CamundaClient

Returns:

a builder for the command that allows setting either a timestamp or an instant

newResetClockCommand

public ResetClockCommandStep1 newResetClockCommand()

Description copied from interface: CamundaClient

Command to reset the Zeebe engine's internal clock to the system time.

This command allows you to reset the clock to the current system time, effectively undoing any previous pin command that may have set the clock to a specific, static time.

 camundaClient
  .newResetClockCommand()
  .send();
 

The command is marked as experimental and may undergo changes or improvements in future releases.

Specified by:

newResetClockCommand in interface CamundaClient

Returns:

a builder for the command

newProcessDefinitionGetRequest

public ProcessDefinitionGetRequest newProcessDefinitionGetRequest(long processDefinitionKey)

Description copied from interface: CamundaClient

Gets a process definition by key.

   long processDefinitionKey = ...;

   camundaClient
   .newProcessDefinitionGetRequest(processDefinitionKey)
   .send();
   

Specified by:

newProcessDefinitionGetRequest in interface CamundaClient

Parameters:

processDefinitionKey - the key of the process definition

Returns:

a builder for the request to get a process definition

newProcessDefinitionGetXmlRequest

public ProcessDefinitionGetXmlRequest newProcessDefinitionGetXmlRequest(long processDefinitionKey)

Description copied from interface: CamundaClient

Retrieves the XML representation of a process definition.

 long processDefinitionKey = ...;

 camundaClient
  .newProcessDefinitionGetXmlRequest(processDefinitionKey)
  .send();
 

Specified by:

newProcessDefinitionGetXmlRequest in interface CamundaClient

Parameters:

processDefinitionKey - the key of the process definition

Returns:

a builder for the request to get the XML of a process definition

newProcessDefinitionGetFormRequest

public ProcessDefinitionGetFormRequest newProcessDefinitionGetFormRequest(long processDefinitionKey)

Description copied from interface: CamundaClient

Retrieves the Form of a process definition.

 long processDefinitionKey = ...;

 camundaClient
  .newProcessDefinitionGetFormRequest(processDefinitionKey)
  .send();
 

Specified by:

newProcessDefinitionGetFormRequest in interface CamundaClient

Parameters:

processDefinitionKey - the key of the process definition

Returns:

a builder for the request to get the Form of process definition

newFormGetRequest

public FormGetRequest newFormGetRequest(long formKey)

Description copied from interface: CamundaClient

Gets a Form by key.

 long formKey = ...;

 camundaClient
  .newFormGetRequest(formKey)
  .send();
 

Specified by:

newFormGetRequest in interface CamundaClient

Parameters:

formKey - the key of the form

Returns:

a builder for the request to get a form

newProcessDefinitionSearchRequest

public ProcessDefinitionSearchRequest newProcessDefinitionSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query process definitions.

 long processDefinitionKey = ...;

 camundaClient
  .newProcessDefinitionSearchRequest()
  .filter((f) -> f.processDefinitionKey(processDefinitionKey))
  .sort((s) -> s.name().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newProcessDefinitionSearchRequest in interface CamundaClient

Returns:

a builder for the process definition search request

newResourceSearchRequest

public ResourceSearchRequest newResourceSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query deployed resources.

 long resourceKey = ...;

 camundaClient
  .newResourceSearchRequest()
  .filter((f) -> f.resourceKey(resourceKey))
  .sort((s) -> s.resourceName().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newResourceSearchRequest in interface CamundaClient

Returns:

a builder for the resource search request

newProcessDefinitionElementStatisticsRequest

public ProcessDefinitionElementStatisticsRequest newProcessDefinitionElementStatisticsRequest(long processDefinitionKey)

Description copied from interface: CamundaClient

Executes a search request to query process definition element statistics.

 long processDefinitionKey = ...;

 camundaClient
  .newProcessDefinitionElementStatisticsRequest(processDefinitionKey)
  .filter((f) -> f.processInstanceKey(processInstanceKey))
  .send();
 

Specified by:

newProcessDefinitionElementStatisticsRequest in interface CamundaClient

Returns:

a builder for the process definition statistics request

newProcessInstanceElementStatisticsRequest

public ProcessInstanceElementStatisticsRequest newProcessInstanceElementStatisticsRequest(long processInstanceKey)

Description copied from interface: CamundaClient

Executes a search request to query process instance element statistics.

 long processInstanceKey = ...;

 camundaClient
  .newProcessInstanceElementStatisticsRequest(processInstanceKey)
  .send();
 

Specified by:

newProcessInstanceElementStatisticsRequest in interface CamundaClient

Returns:

a builder for the process instance statistics request

newProcessInstanceWaitStateStatisticsRequest

public ProcessInstanceWaitStateStatisticsRequest newProcessInstanceWaitStateStatisticsRequest(long processInstanceKey)

Description copied from interface: CamundaClient

Executes a request to query process instance wait state statistics, grouped by element id.

 long processInstanceKey = ...;

 camundaClient
  .newProcessInstanceWaitStateStatisticsRequest(processInstanceKey)
  .send();
 

Specified by:

newProcessInstanceWaitStateStatisticsRequest in interface CamundaClient

Returns:

a builder for the process instance wait state statistics request

newProcessDefinitionMessageSubscriptionStatisticsRequest

public ProcessDefinitionMessageSubscriptionStatisticsRequest newProcessDefinitionMessageSubscriptionStatisticsRequest()

Description copied from interface: CamundaClient

Executes a search request to query process definition message subscription statistics.

 camundaClient
  .newProcessDefinitionMessageSubscriptionStatisticsRequest()
  .send();
 

Specified by:

newProcessDefinitionMessageSubscriptionStatisticsRequest in interface CamundaClient

Returns:

a builder for the process definition message subscription statistics request

newUsageMetricsRequest

public UsageMetricsStatisticsRequest newUsageMetricsRequest(OffsetDateTime startTime,
 OffsetDateTime endTime)

Description copied from interface: CamundaClient

Executes a search request to query usage metrics statistics.

 camundaClient
  .newUsageMetricsRequest(OffsetDateTime.now().minusYears(1), OffsetDateTime.now())
  .withTenants(true)
  .send();
 

Specified by:

newUsageMetricsRequest in interface CamundaClient

Returns:

a builder for the usage metrics statistics request

newGlobalJobStatisticsRequest

public GlobalJobStatisticsRequest newGlobalJobStatisticsRequest(OffsetDateTime from,
 OffsetDateTime to)

Description copied from interface: CamundaClient

Executes a request to query global job statistics.

 camundaClient
  .newGlobalJobStatisticsRequest(OffsetDateTime.now().minusDays(1), OffsetDateTime.now())
  .jobType("myJobType")
  .send();
 

Specified by:

newGlobalJobStatisticsRequest in interface CamundaClient

Parameters:

from - the start of the time range (inclusive)

to - the end of the time range (inclusive)

Returns:

a builder for the global job statistics request

newJobTypeStatisticsRequest

public JobTypeStatisticsRequest newJobTypeStatisticsRequest(OffsetDateTime from,
 OffsetDateTime to)

Description copied from interface: CamundaClient

Executes a request to query job statistics grouped by job type.

 camundaClient
  .newJobTypeStatisticsRequest(OffsetDateTime.now().minusDays(1), OffsetDateTime.now())
  .filter(f -> f.jobType(jt -> jt.like("fetch-*")))
  .send();
 

Specified by:

newJobTypeStatisticsRequest in interface CamundaClient

Parameters:

from - the start of the time range (inclusive)

to - the end of the time range (inclusive)

Returns:

a builder for the job type statistics request

newJobWorkerStatisticsRequest

public JobWorkerStatisticsRequest newJobWorkerStatisticsRequest(OffsetDateTime from,
 OffsetDateTime to,
 String jobType)

Description copied from interface: CamundaClient

Executes a request to query job statistics grouped by worker for a specific job type.

 camundaClient
  .newJobWorkerStatisticsRequest(OffsetDateTime.now().minusDays(1), OffsetDateTime.now(), "fetch-customer-data")
  .send();
 

Specified by:

newJobWorkerStatisticsRequest in interface CamundaClient

Parameters:

from - the start of the time range (inclusive)

to - the end of the time range (inclusive)

jobType - the job type to return worker statistics for

Returns:

a builder for the job worker statistics request

newJobTimeSeriesStatisticsRequest

public JobTimeSeriesStatisticsRequest newJobTimeSeriesStatisticsRequest(OffsetDateTime from,
 OffsetDateTime to,
 String jobType)

Description copied from interface: CamundaClient

Executes a request to query time-bucketed job metrics for a specific job type.

 camundaClient
  .newJobTimeSeriesStatisticsRequest(OffsetDateTime.now().minusDays(1), OffsetDateTime.now(), "fetch-customer-data")
  .resolution(Duration.ofMinutes(1))
  .send();
 

Specified by:

newJobTimeSeriesStatisticsRequest in interface CamundaClient

Parameters:

from - the start of the time range (inclusive)

to - the end of the time range (inclusive)

jobType - the job type to return time-series metrics for

Returns:

a builder for the job time-series statistics request

newJobErrorStatisticsRequest

public JobErrorStatisticsRequest newJobErrorStatisticsRequest(OffsetDateTime from,
 OffsetDateTime to,
 String jobType)

Description copied from interface: CamundaClient

Executes a request to query per-error job metrics for a specific job type. Supports optional errorCode / errorMessage filters.

 camundaClient
  .newJobErrorStatisticsRequest(OffsetDateTime.now().minusDays(1), OffsetDateTime.now(), "fetch-customer-data")
  .filter(f -> f.errorCode(c -> c.like("UNHANDLED_*")))
  .send();
 

Specified by:

newJobErrorStatisticsRequest in interface CamundaClient

Parameters:

from - the start of the time range (inclusive)

to - the end of the time range (inclusive)

jobType - the job type to return error metrics for

Returns:

a builder for the job error statistics request

newProcessInstanceSequenceFlowsRequest

public ProcessInstanceSequenceFlowsRequest newProcessInstanceSequenceFlowsRequest(long processInstanceKey)

Description copied from interface: CamundaClient

Executes a search request to query process instance sequence flows.

 long processInstanceKey = ...;

 camundaClient
  .newProcessInstanceSequenceFlowsRequest(processInstanceKey)
  .send();
 

Specified by:

newProcessInstanceSequenceFlowsRequest in interface CamundaClient

Returns:

a builder for the process instance sequence flows request

newProcessInstanceGetRequest

public ProcessInstanceGetRequest newProcessInstanceGetRequest(long processInstanceKey)

Description copied from interface: CamundaClient

Retrieves a process instance by key.

 long processInstanceKey = ...;

 camundaClient
  .newProcessInstanceGetRequest(processInstanceKey)
  .send();
 

Specified by:

newProcessInstanceGetRequest in interface CamundaClient

Returns:

a builder for the request to get a process instance

newProcessInstanceSearchRequest

public ProcessInstanceSearchRequest newProcessInstanceSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query process instances.

 long processInstanceKey = ...;

 camundaClient
  .newProcessInstanceSearchRequest()
  .filter((f) -> f.processInstanceKeys(processInstanceKey))
  .sort((s) -> s.startDate().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newProcessInstanceSearchRequest in interface CamundaClient

Returns:

a builder for the process instance search request

newElementInstanceSearchRequest

public ElementInstanceSearchRequest newElementInstanceSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query element instances.

 long elementInstanceKey = ...;

 camundaClient
  .newElementInstanceSearchRequest()
  .filter((f) -> f.processInstanceKeys(processInstanceKey))
  .sort((s) -> s.elementName().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newElementInstanceSearchRequest in interface CamundaClient

Returns:

a builder for the process instance search request

newElementInstanceGetRequest

public ElementInstanceGetRequest newElementInstanceGetRequest(long elementInstanceKey)

Description copied from interface: CamundaClient

Gets a element instance by key.

   long elementInstanceKey = ...;

   camundaClient
   .newElementInstanceGetRequest(elementInstanceKey)
   .send();
   

Specified by:

newElementInstanceGetRequest in interface CamundaClient

Parameters:

elementInstanceKey - the key of the element instance

Returns:

a builder for the request to get a element instance

newActivateAdHocSubProcessActivitiesCommand

public ActivateAdHocSubProcessActivitiesCommandStep1 newActivateAdHocSubProcessActivitiesCommand(String adHocSubProcessInstanceKey)

Description copied from interface: CamundaClient

Command to activate activities within an activated ad-hoc sub-process.

   camundaClient
    .newActivateAdHocSubProcessActivitiesCommand(adHocSubProcessInstanceKey)
    .activateElement("A")
    .activateElements("B", "C")
    .activateElements(Arrays.asList("D", "E"))
    .send();
 

Specified by:

newActivateAdHocSubProcessActivitiesCommand in interface CamundaClient

Parameters:

adHocSubProcessInstanceKey - the key which identifies the corresponding ad-hoc sub-process instance

Returns:

a builder for the command

newUserTaskSearchRequest

public UserTaskSearchRequest newUserTaskSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query user tasks.

 camundaClient
  .newUserTaskSearchRequest()
  .filter((f) -> f.userTaskKey(userTaskKey))
  .sort((s) -> s.creationDate().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newUserTaskSearchRequest in interface CamundaClient

Returns:

a builder for the user task search request

newDecisionRequirementsSearchRequest

public DecisionRequirementsSearchRequest newDecisionRequirementsSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query Decision Requirements.

   camundaClient
   .newDecisionRequirementsSearchRequest()
   .filter((f) -> f.decisionRequirementsKey(decisionRequirementsKey))
   .sort((s) -> s.version().asc())
   .page((p) -> p.limit(100))
   .send();
   

Specified by:

newDecisionRequirementsSearchRequest in interface CamundaClient

Returns:

a builder for the decision requirements search request

newDecisionDefinitionSearchRequest

public DecisionDefinitionSearchRequest newDecisionDefinitionSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query decision definitions.

 long decisionDefinitionKey = ...;

 camundaClient
  .newDecisionDefinitionQuery()
  .filter((f) -> f.decisionKey(decisionDefinitionKey))
  .sort((s) -> s.dmnDecisionName().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newDecisionDefinitionSearchRequest in interface CamundaClient

Returns:

a builder for the decision definition search request

newDecisionDefinitionGetRequest

public DecisionDefinitionGetRequest newDecisionDefinitionGetRequest(long decisionDefinitionKey)

Description copied from interface: CamundaClient

Gets a decision definition by key.

   long decisionDefinitionKey = ...;

   camundaClient
   .newDecisionDefinitionGetRequest(decisionDefinitionKey)
   .send();
   

Specified by:

newDecisionDefinitionGetRequest in interface CamundaClient

Parameters:

decisionDefinitionKey - the key of the decision definition

Returns:

a builder for the request to get a decision definition

newDecisionDefinitionGetXmlRequest

public DecisionDefinitionGetXmlRequest newDecisionDefinitionGetXmlRequest(long decisionKey)

Description copied from interface: CamundaClient

Retrieves the XML representation of a decision definition.

 long decisionDefinitionKey = ...;

 camundaClient
  .newDecisionDefinitionGetXmlRequest(decisionDefinitionKey)
  .send();
 

Specified by:

newDecisionDefinitionGetXmlRequest in interface CamundaClient

Parameters:

decisionKey - the key of the decision definition

Returns:

a builder for the request to get the XML of a decision definition

newDecisionInstanceSearchRequest

public DecisionInstanceSearchRequest newDecisionInstanceSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query decision instances.

 long decisionInstanceKey = ...;

 camundaClient
  .newDecisionInstanceSearchRequest()
  .filter((f) -> f.decisionInstanceKey(decisionInstanceKey))
  .sort((s) -> s.decisionInstanceKey().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newDecisionInstanceSearchRequest in interface CamundaClient

Returns:

a builder for the decision instance search request

newDecisionInstanceGetRequest

public DecisionInstanceGetRequest newDecisionInstanceGetRequest(String decisionInstanceId)

Description copied from interface: CamundaClient

Retrieves a decision instance by id.

 String decisionInstanceId = ...;

 camundaClient
 .newDecisionInstanceGetQuery(decisionInstanceId)
 .send();
 

Specified by:

newDecisionInstanceGetRequest in interface CamundaClient

Parameters:

decisionInstanceId - the id of the decision instance to fetch

Returns:

a builder for the request to get a decision instance

newDeleteDecisionInstanceCommand

public DeleteDecisionInstanceCommandStep1 newDeleteDecisionInstanceCommand(long decisionInstanceKey)

Description copied from interface: CamundaClient

Command to delete a decision instance history.

 camundaClient
  .newDeleteDecisionInstanceCommand(decisionEvaluationKey)
  .send();
 

Specified by:

newDeleteDecisionInstanceCommand in interface CamundaClient

Parameters:

decisionInstanceKey - the key which identifies the corresponding decision evaluation

Returns:

a builder for the command

newIncidentSearchRequest

public IncidentSearchRequest newIncidentSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query incidents.

 long processInstanceKey = ...;

 camundaClient
  .newIncidentSearchRequest()
  .filter((f) -> f.processInstanceKey(processInstanceKey))
  .sort((s) -> s.processDefinitionKey().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newIncidentSearchRequest in interface CamundaClient

Returns:

a builder for the incident search request

newIncidentGetRequest

public IncidentGetRequest newIncidentGetRequest(long incidentKey)

Description copied from interface: CamundaClient

Gets an incident by key.

   long incidentKey = ...;

   camundaClient
   .newIncidentGetRequest(incidentKey)
   .send();
   

Specified by:

newIncidentGetRequest in interface CamundaClient

Parameters:

incidentKey - the key of the incident

Returns:

a builder for the request to get an incident

newCreateRoleCommand

public CreateRoleCommandStep1 newCreateRoleCommand()

Description copied from interface: CamundaClient

Command to create a role.

 camundaClient
  .newRoleCreateCommand()
  .roleId("roleId")
  .name(name)
  .description("description")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newCreateRoleCommand in interface CamundaClient

Returns:

a builder for the command

newRoleGetRequest

public RoleGetRequest newRoleGetRequest(String roleId)

Description copied from interface: CamundaClient

Request to get a role by role ID.

 camundaClient
  .newRoleGetRequest("roleId")
  .send();
 

Specified by:

newRoleGetRequest in interface CamundaClient

Parameters:

roleId - the ID of the role

Returns:

a builder for the request to get a role

newRolesSearchRequest

public RolesSearchRequest newRolesSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query roles.

 camundaClient
  .newRolesSearchRequest()
  .filter((f) -> f.name("roleName"))
  .sort((s) -> s.name().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newRolesSearchRequest in interface CamundaClient

Returns:

a builder for the roles search request

newUpdateRoleCommand

public UpdateRoleCommandStep1 newUpdateRoleCommand(String roleId)

Description copied from interface: CamundaClient

Command to update a role.

 camundaClient
  .newUpdateRoleCommand("roleId")
  .name("name")
  .description("description")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUpdateRoleCommand in interface CamundaClient

Returns:

a builder for the command

newAssignRoleToMappingRuleCommand

public AssignRoleToMappingRuleCommandStep1 newAssignRoleToMappingRuleCommand()

Description copied from interface: CamundaClient

Command to assign a role to a mapping rule.

 camundaClient
  .newAssignRoleToMappingRuleCommand()
  .roleId("roleId")
  .mappingRuleId("mappingRuleId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignRoleToMappingRuleCommand in interface CamundaClient

Returns:

a builder to configure and send the assign role to mapping rule command

newDeleteRoleCommand

public DeleteRoleCommandStep1 newDeleteRoleCommand(String roleId)

Description copied from interface: CamundaClient

Command to delete a role by role ID.

 camundaClient
  .newDeleteRoleCommand("roleId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newDeleteRoleCommand in interface CamundaClient

Returns:

a builder for the command

newAssignRoleToGroupCommand

public AssignRoleToGroupCommandStep1 newAssignRoleToGroupCommand()

Description copied from interface: CamundaClient

Command to assign a role to a group.

 camundaClient
  .newAssignRoleToGroupCommand()
  .roleId("roleId")
  .groupId("groupId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignRoleToGroupCommand in interface CamundaClient

Returns:

a builder to configure and send the assign role to group command

newAssignRoleToClientCommand

public AssignRoleToClientCommandStep1 newAssignRoleToClientCommand()

Description copied from interface: CamundaClient

Command to assign a role to a client.

 camundaClient
  .newAssignRoleToClientCommand()
  .roleId("roleId")
  .clientId("clientId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignRoleToClientCommand in interface CamundaClient

Returns:

a builder to configure and send the assign role to client command

newClientsByRoleSearchRequest

public ClientsByRoleSearchRequest newClientsByRoleSearchRequest(String roleId)

Description copied from interface: CamundaClient

Executes a search request to query clients by role.

 camundaClient
   .newClientsByRoleSearchRequest("roleId")
   .sort((s) -> s.clientId().asc())
   .page((p) -> p.limit(100))
   .send();
 

Specified by:

newClientsByRoleSearchRequest in interface CamundaClient

Parameters:

roleId - the ID of the role

Returns:

a builder for the clients by role search request

newClientsByGroupSearchRequest

public ClientsByGroupSearchRequest newClientsByGroupSearchRequest(String groupId)

Description copied from interface: CamundaClient

Executes a search request to query clients by group.

 camundaClient
   .newClientsByGroupSearchRequest("groupId")
   .sort((s) -> s.clientId().asc())
   .page((p) -> p.limit(100))
   .send();
 

Specified by:

newClientsByGroupSearchRequest in interface CamundaClient

Parameters:

groupId - the ID of the group

Returns:

a builder for the clients by group search request

newClientsByTenantSearchRequest

public ClientsByTenantSearchRequest newClientsByTenantSearchRequest(String tenantId)

Description copied from interface: CamundaClient

Executes a search request to query clients by tenant.

 camundaClient
   .newClientsByTenantSearchRequest("tenantId")
   .sort((s) -> s.clientId().asc())
   .page((p) -> p.limit(100))
   .send();
 

Specified by:

newClientsByTenantSearchRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the clients by tenant search request

newAssignRoleToTenantCommand

public AssignRoleToTenantCommandStep1 newAssignRoleToTenantCommand()

Description copied from interface: CamundaClient

Command to assign a role to a tenant.

 camundaClient
  .newAssignRoleToTenantCommand()
  .roleId("roleId")
  .tenantId("tenantId")
  .send();
 

This command is only sent via REST over HTTP.

Specified by:

newAssignRoleToTenantCommand in interface CamundaClient

Returns:

a builder for the assign role to tenant command

newUnassignRoleFromTenantCommand

public UnassignRoleFromTenantCommandStep1 newUnassignRoleFromTenantCommand()

Description copied from interface: CamundaClient

Command to unassign a role from a tenant.

 camundaClient
  .newUnassignRoleFromTenantCommand()
  .roleId("roleId")
  .tenantId("tenantId")
  .send();
 

This command is only sent via REST over HTTP.

Specified by:

newUnassignRoleFromTenantCommand in interface CamundaClient

Returns:

a builder for the unassign role from tenant command

newRolesByTenantSearchRequest

public RolesByTenantSearchRequest newRolesByTenantSearchRequest(String tenantId)

Description copied from interface: CamundaClient

Executes a search request to query roles assigned to a specific tenant.

 camundaClient
  .newRolesByTenantSearchRequest("tenantId")
  .filter((f) -> f.name("admin"))
  .sort((s) -> s.name().asc())
  .page((p) -> p.limit(50))
  .send();
 

Specified by:

newRolesByTenantSearchRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the roles by tenant search request

newUnassignRoleFromGroupCommand

public UnassignRoleFromGroupCommandStep1 newUnassignRoleFromGroupCommand()

Description copied from interface: CamundaClient

Command to unassign a role from a group.

Example usage:

 camundaClient
   .newUnassignRoleFromGroupCommand()
   .roleId("roleId")
   .groupId("groupId")
   .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignRoleFromGroupCommand in interface CamundaClient

Returns:

a builder for the unassign role from group command

newUnassignRoleFromMappingRuleCommand

public UnassignRoleFromMappingRuleCommandStep1 newUnassignRoleFromMappingRuleCommand()

Description copied from interface: CamundaClient

Command to unassign a role from a mapping rule.

Example usage:

 camundaClient
   .newUnassignRoleFromMappingRuleCommand()
   .roleId("roleId")
   .mappingRuleId("mappingRuleId")
   .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignRoleFromMappingRuleCommand in interface CamundaClient

Returns:

a builder for the unassign role from mapping rule command

newUnassignRoleFromClientCommand

public UnassignRoleFromClientCommandStep1 newUnassignRoleFromClientCommand()

Description copied from interface: CamundaClient

Command to unassign a role from a client.

Example usage:

 camundaClient
   .newUnassignRoleFromClientCommand()
   .roleId("roleId")
   .clientId("clientId")
   .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignRoleFromClientCommand in interface CamundaClient

Returns:

a builder for the unassign role from client command

newAssignRoleToUserCommand

public AssignRoleToUserCommandStep1 newAssignRoleToUserCommand()

Description copied from interface: CamundaClient

Command to assign a role to a user.

Example usage:

 camundaClient
   .newAssignRoleToUserCommand()
   .roleId("roleId")
   .username("username")
   .send();
 

Specified by:

newAssignRoleToUserCommand in interface CamundaClient

Returns:

a builder for the assign role to user command

newUnassignRoleFromUserCommand

public UnassignRoleFromUserCommandStep1 newUnassignRoleFromUserCommand()

Description copied from interface: CamundaClient

Command to unassign a role from a user.

 camundaClient
   .newUnassignRoleFromUserCommand()
   .roleId("roleId")
   .username("username")
   .send();
 

This command is only sent via REST over HTTP, not via gRPC.

Specified by:

newUnassignRoleFromUserCommand in interface CamundaClient

Returns:

a builder for the unassign role from user command

newUsersByRoleSearchRequest

public UsersByRoleSearchRequest newUsersByRoleSearchRequest(String roleId)

Description copied from interface: CamundaClient

Executes a search request to query users by role.

 camundaClient
  .newUsersByRoleSearchRequest("roleId")
  .sort((s) -> s.username().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newUsersByRoleSearchRequest in interface CamundaClient

Parameters:

roleId - the ID of the role

Returns:

a builder for the users by role search request

newUsersByTenantSearchRequest

public UsersByTenantSearchRequest newUsersByTenantSearchRequest(String tenantId)

Description copied from interface: CamundaClient

Executes a search request to query users assigned to a tenant.

 camundaClient
  .newUsersByTenantSearchRequest("tenantId")
  .sort((s) -> s.username().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newUsersByTenantSearchRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the users by tenant search request

newUsersSearchRequest

public UsersSearchRequest newUsersSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query users.

 camundaClient
  .newUsersSearchRequest()
  .filter((f) -> f.username("userName"))
  .sort((s) -> s.username().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newUsersSearchRequest in interface CamundaClient

Returns:

a builder for the users search request

newCreateGroupCommand

public CreateGroupCommandStep1 newCreateGroupCommand()

Description copied from interface: CamundaClient

Command to create a group.

 camundaClient
  .newCreateGroupCommand()
  .groupId("groupId")
  .name("name")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newCreateGroupCommand in interface CamundaClient

Returns:

a builder for the command

newUpdateGroupCommand

public UpdateGroupCommandStep1 newUpdateGroupCommand(String groupId)

Description copied from interface: CamundaClient

Command to update a group.

 camundaClient
  .newUpdateGroupCommand("groupId")
  .name("name")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUpdateGroupCommand in interface CamundaClient

Returns:

a builder for the command

newDeleteGroupCommand

public DeleteGroupCommandStep1 newDeleteGroupCommand(String groupId)

Description copied from interface: CamundaClient

Command to delete a group.

 camundaClient
  .newDeleteGroupCommand("groupId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newDeleteGroupCommand in interface CamundaClient

Returns:

a builder for the command

newDeleteMappingRuleCommand

public DeleteMappingRuleCommandStep1 newDeleteMappingRuleCommand(String mappingRuleId)

Description copied from interface: CamundaClient

Command to delete a mapping rule.

 camundaClient
  .newDeleteMappingRuleCommand("mappingRuleId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newDeleteMappingRuleCommand in interface CamundaClient

Parameters:

mappingRuleId - the ID of the mapping rule to delete

Returns:

a builder for the command

newMappingRuleGetRequest

public MappingRuleGetRequest newMappingRuleGetRequest(String mappingRuleId)

Description copied from interface: CamundaClient

Request to get a mapping rule by mapping rule ID.

 camundaClient
  .newMappingRuleGetRequest("mappingRuleId")
  .send();
 

Specified by:

newMappingRuleGetRequest in interface CamundaClient

Parameters:

mappingRuleId - the ID of the mapping rule

Returns:

a builder for the request to get a mapping rule

newAssignUserToGroupCommand

public AssignUserToGroupCommandStep1 newAssignUserToGroupCommand()

Description copied from interface: CamundaClient

Command to assign a user to a group.

 camundaClient
  .newAssignUserToGroupCommand()
  .username("username")
  .groupId("groupId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignUserToGroupCommand in interface CamundaClient

Returns:

a builder for the command

newUnassignUserFromGroupCommand

public UnassignUserFromGroupCommandStep1 newUnassignUserFromGroupCommand()

Description copied from interface: CamundaClient

Command to unassign a user from a group.

 camundaClient
  .newUnassignUserFromGroupCommand()
  .username("username")
  .groupId("groupId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignUserFromGroupCommand in interface CamundaClient

Returns:

a builder for the command

newCreateUserCommand

public CreateUserCommandStep1 newCreateUserCommand()

Description copied from interface: CamundaClient

Command to create a user.

 camundaClient
  .newCreateUserCommand()
  .username(username)
  .email(email)
  .name(name)
  .password(password)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newCreateUserCommand in interface CamundaClient

Returns:

a builder for the command

newDeleteUserCommand

public DeleteUserCommandStep1 newDeleteUserCommand(String username)

Description copied from interface: CamundaClient

Command to delete a user by username

 camundaClient
  .newDeleteUserCommand("username")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newDeleteUserCommand in interface CamundaClient

Returns:

a builder for the command

newUpdateUserCommand

public UpdateUserCommandStep1 newUpdateUserCommand(String username)

Description copied from interface: CamundaClient

Command to update a user.

 camundaClient
  .newUpdateUserCommand("username")
  .name("name")
  .email("email@email.com")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUpdateUserCommand in interface CamundaClient

Returns:

a builder for the command

newUserGetRequest

public UserGetRequest newUserGetRequest(String username)

Description copied from interface: CamundaClient

Request to get a user by username.

 camundaClient
  .newUserGetRequest("username")
  .send();
 

Specified by:

newUserGetRequest in interface CamundaClient

Parameters:

username - the username of the user

Returns:

a builder for the request to get a user

newCreateMappingRuleCommand

public CreateMappingRuleCommandStep1 newCreateMappingRuleCommand()

Description copied from interface: CamundaClient

Command to create a mapping rule.

 camundaClient
  .newCreateMappingRuleCommand()
  .claimName(claimName)
  .claimValue(claimValue)
  .mappingRuleId(mappingRuleId)
  .name(name)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newCreateMappingRuleCommand in interface CamundaClient

Returns:

a builder for the command

newUpdateMappingRuleCommand

public UpdateMappingRuleCommandStep1 newUpdateMappingRuleCommand(String mappingRuleId)

Description copied from interface: CamundaClient

Command to update a mapping rule.

 camundaClient
  .newUpdateMappingRule("mappingRuleId")
  .name("name")
  .claimName("claim name")
  .claimValue("claim value")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUpdateMappingRuleCommand in interface CamundaClient

Returns:

a builder for the command

newDecisionRequirementsGetXmlRequest

public DecisionRequirementsGetXmlRequest newDecisionRequirementsGetXmlRequest(long decisionRequirementsKey)

Description copied from interface: CamundaClient

Retrieves the XML representation of a decision requirements.

 long decisionRequirementsKey = ...;

 camundaClient
  .newDecisionRequirementsGetXmlRequest(decisionRequirementsKey)
  .send();
 

Specified by:

newDecisionRequirementsGetXmlRequest in interface CamundaClient

Returns:

a builder for the request to get the XML of a decision definition

newDecisionRequirementsGetRequest

public DecisionRequirementsGetRequest newDecisionRequirementsGetRequest(long decisionRequirementsKey)

Description copied from interface: CamundaClient

Gets a decision requirements by key.

   long decisionRequirementsKey = ...;

   camundaClient
   .newDecisionRequirementsGetRequest(decisionRequirementsKey)
   .send();
   

Specified by:

newDecisionRequirementsGetRequest in interface CamundaClient

Parameters:

decisionRequirementsKey - the key of the decision requirements

Returns:

a builder for the request to get a decision requirements

newUserTaskGetFormRequest

public UserTaskGetFormRequest newUserTaskGetFormRequest(long userTaskKey)

Description copied from interface: CamundaClient

Gets a user task form by key.

   long userTaskKey = ...;

   camundaClient
   .newUserTaskGetFormRequest(userTaskKey)
   .send();
   

Specified by:

newUserTaskGetFormRequest in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the request to get a user task form

newUserTaskGetRequest

public UserTaskGetRequest newUserTaskGetRequest(long userTaskKey)

Description copied from interface: CamundaClient

Gets a User Task by key.

   long userTaskKey = ...;

   camundaClient
   .newUserTaskGetRequest(userTaskKey)
   .send();
   

Specified by:

newUserTaskGetRequest in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the request to get a user task

newVariableSearchRequest

public VariableSearchRequest newVariableSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query variables.

 camundaClient
  .newVariableSearchRequest()
  .filter((f) -> f.variableKey(variableKey))
  .sort((s) -> s.value().asc())
  .page((p) -> p.limit(100))
  .withFullValues()
  .send();
 

Specified by:

newVariableSearchRequest in interface CamundaClient

Returns:

a builder for the variable search request

newVariableGetRequest

public VariableGetRequest newVariableGetRequest(long variableKey)

Description copied from interface: CamundaClient

Gets a variable by key.

   long variableKey = ...;

  camundaClient
 .newVariableGetRequest(variableKey)
 .send();
 

Specified by:

newVariableGetRequest in interface CamundaClient

Parameters:

variableKey - the key of the variable

Returns:

a builder for the request to get a variable

newGloballyScopedClusterVariableCreateRequest

public GloballyScopedClusterVariableCreationCommandStep1 newGloballyScopedClusterVariableCreateRequest()

Description copied from interface: CamundaClient

Creates a request to create a new globally-scoped cluster variable.

   camundaClient
       .newGloballyScopedClusterVariableCreateRequest()
       .create("myVariable", "myValue")
       .send();
 

Specified by:

newGloballyScopedClusterVariableCreateRequest in interface CamundaClient

Returns:

a builder for creating a globally-scoped cluster variable

newTenantScopedClusterVariableCreateRequest

public TenantScopedClusterVariableCreationCommandStep1 newTenantScopedClusterVariableCreateRequest(String tenantId)

Description copied from interface: CamundaClient

Creates a request to create a new tenant-scoped cluster variable.

   camundaClient
       .newTenantScopedClusterVariableCreateRequest("my-tenant-id")
       .create("myVariable", "myValue")
       .send();
 

Specified by:

newTenantScopedClusterVariableCreateRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant for which the variable is scoped

Returns:

a builder for creating a tenant-scoped cluster variable

newGloballyScopedClusterVariableUpdateRequest

public GloballyScopedClusterVariableUpdateCommandStep1 newGloballyScopedClusterVariableUpdateRequest()

Description copied from interface: CamundaClient

Creates a request to update a globally-scoped cluster variable.

   camundaClient
       .newGloballyScopedClusterVariableUpdateRequest()
       .update("myVariable", "newValue")
       .send();
 

Specified by:

newGloballyScopedClusterVariableUpdateRequest in interface CamundaClient

Returns:

a builder for updating a globally-scoped cluster variable

newTenantScopedClusterVariableUpdateRequest

public TenantScopedClusterVariableUpdateCommandStep1 newTenantScopedClusterVariableUpdateRequest(String tenantId)

Description copied from interface: CamundaClient

Creates a request to update a tenant-scoped cluster variable.

   camundaClient
       .newTenantScopedClusterVariableUpdateRequest("my-tenant-id")
       .update("myVariable", "newValue")
       .send();
 

Specified by:

newTenantScopedClusterVariableUpdateRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant for which the variable is scoped

Returns:

a builder for updating a tenant-scoped cluster variable

newGloballyScopedClusterVariableDeleteRequest

public GloballyScopedClusterVariableDeletionCommandStep1 newGloballyScopedClusterVariableDeleteRequest()

Description copied from interface: CamundaClient

Creates a request to delete a globally-scoped cluster variable.

   camundaClient
       .newGloballyScopedClusterVariableDeleteRequest()
       .delete("myVariable")
       .send();
 

Specified by:

newGloballyScopedClusterVariableDeleteRequest in interface CamundaClient

Returns:

a builder for deleting a globally-scoped cluster variable

newTenantScopedClusterVariableDeleteRequest

public TenantScopedClusterVariableDeletionCommandStep1 newTenantScopedClusterVariableDeleteRequest(String tenantId)

Description copied from interface: CamundaClient

Creates a request to delete a tenant-scoped cluster variable.

   camundaClient
       .newTenantScopedClusterVariableDeleteRequest("my-tenant-id")
       .delete("myVariable")
       .send();
 

Specified by:

newTenantScopedClusterVariableDeleteRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant for which the variable is scoped

Returns:

a builder for deleting a tenant-scoped cluster variable

newGloballyScopedClusterVariableGetRequest

public GloballyScopedClusterVariableGetRequest newGloballyScopedClusterVariableGetRequest()

Description copied from interface: CamundaClient

Creates a request to fetch a globally-scoped cluster variable by name.

   camundaClient
       .newGloballyScopedClusterVariableGetRequest()
       .withName("myVariable")
       .send();
 

Specified by:

newGloballyScopedClusterVariableGetRequest in interface CamundaClient

Returns:

a builder for fetching a globally-scoped cluster variable

newTenantScopedClusterVariableGetRequest

public TenantScopedClusterVariableGetRequest newTenantScopedClusterVariableGetRequest(String tenantId)

Description copied from interface: CamundaClient

Creates a request to fetch a tenant-scoped cluster variable by name.

   camundaClient
       .newTenantScopedClusterVariableGetRequest("my-tenant-id")
       .withName("myVariable")
       .send();
 

Specified by:

newTenantScopedClusterVariableGetRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant for which the variable is scoped

Returns:

a builder for fetching a tenant-scoped cluster variable

newClusterVariableSearchRequest

public ClusterVariableSearchRequest newClusterVariableSearchRequest()

Description copied from interface: CamundaClient

Creates a request to search for cluster variables.

Cluster variables can be searched with filtering and sorting capabilities:

   camundaClient
       .newClusterVariableSearchRequest()
       .filter(f -> f.scope(ClusterVariableScope.GLOBAL))
       .sort(s -> s.name().asc())
       .send();

   // or for tenant-scoped variables
   camundaClient
       .newClusterVariableSearchRequest()
       .filter(f -> f.scope(ClusterVariableScope.TENANT).tenantId("my-tenant-id"))
       .send();
 

Specified by:

newClusterVariableSearchRequest in interface CamundaClient

Returns:

a builder for searching cluster variables

newUserTaskVariableSearchRequest

public UserTaskVariableSearchRequest newUserTaskVariableSearchRequest(long userTaskKey)

Description copied from interface: CamundaClient

Executes a search request to query variables related to a user task.

   long userTaskKey = ...;

  camundaClient
   .newUserTaskVariableSearchRequest(userTaskKey)
   .sort((s) -> s.value().asc())
   .page((p) -> p.limit(100))
   .withFullValues()
   .send();
 

Specified by:

newUserTaskVariableSearchRequest in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the user task variable search request

newUserTaskEffectiveVariableSearchRequest

public UserTaskEffectiveVariableSearchRequest newUserTaskEffectiveVariableSearchRequest(long userTaskKey)

Description copied from interface: CamundaClient

Executes a search request to query effective variables related to a user task. Returns deduplicated variables where the innermost scope wins when the same variable name exists at multiple scope levels.

   long userTaskKey = ...;

  camundaClient
   .newUserTaskEffectiveVariableSearchRequest(userTaskKey)
   .sort((s) -> s.value().asc())
   .page((p) -> p.limit(100))
   .withFullValues()
   .send();
 

Specified by:

newUserTaskEffectiveVariableSearchRequest in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the user task effective variable search request

newCreateDocumentCommand

public CreateDocumentCommandStep1 newCreateDocumentCommand()

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to create a document.

   camundaClient
   .newCreateDocumentCommand()
   .content(inputStream)
   .fileName("file.txt")
   .timeToLive(Duration.ofDays(1))
   .send();
 

Specified by:

newCreateDocumentCommand in interface CamundaClient

Returns:

a builder for the command

newCreateDocumentBatchCommand

public CreateDocumentBatchCommandStep1 newCreateDocumentBatchCommand()

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to create a batch of documents. Unlike CamundaClient.newCreateDocumentCommand(), this command allows you to create multiple documents in a single request. This can be more efficient than creating each document individually, however, there are multiple limitations to consider.

Limitations:

• The gateway does not guarantee the atomicity of the batch operation. If the gateway receives the batch but fails to create one or more documents, it will not roll back the operation. This means that some documents may be created while others are not. The client should handle this scenario by checking the response for each document.
• Each document in the batch must have a unique name.
• It is not possible to assign a custom document ID to the documents in the batch. The document ID will be generated by the broker.
• The total size of the batch must not exceed the multipart request size limit of the gateway.
• The documents can only be created in a single store. If you need to create documents in multiple stores, you must create separate batches for each store.

   zeebeClient
   .newCreateDocumentBatchCommand()
   .addDocument()
   .content(inputStream1)
   .fileName("file1.txt")
   .timeToLive(Duration.ofDays(1))
   .done()
   .addDocument()
   .content(inputStream2)
   .fileName("file2.txt")
   .timeToLive(Duration.ofDays(1))
   .done()
   

Specified by:

newCreateDocumentBatchCommand in interface CamundaClient

Returns:

a builder for the command

newDocumentContentGetRequest

public DocumentContentGetRequest newDocumentContentGetRequest(String documentId)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to get a document.

   camundaClient
   .newDocumentContentGetRequest(documentId)
   .storeId(storeId)
   .send();
   

Specified by:

newDocumentContentGetRequest in interface CamundaClient

Parameters:

documentId - the id of the document

Returns:

a builder for the request

newDocumentContentGetRequest

public DocumentContentGetRequest newDocumentContentGetRequest(DocumentReferenceResponse documentReference)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to get a document.

   camundaClient
   .newDocumentContentGetRequest(documentReferenceResponse)
   .send();
   

Specified by:

newDocumentContentGetRequest in interface CamundaClient

Parameters:

documentReference - the reference of the document

Returns:

a builder for the request

newCreateDocumentLinkCommand

public CreateDocumentLinkCommandStep1 newCreateDocumentLinkCommand(String documentId)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to update a document.

   camundaClient
   .newCreateDocumentLinkCommand(documentId)
   .storeId(storeId)
   .timeToLive(Duration.ofHours(1))
   .send();
   

Specified by:

newCreateDocumentLinkCommand in interface CamundaClient

Parameters:

documentId - the id of the document

Returns:

a builder for the command

newCreateDocumentLinkCommand

public CreateDocumentLinkCommandStep1 newCreateDocumentLinkCommand(DocumentReferenceResponse documentReference)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to update a document.

   camundaClient
   .newCreateDocumentLinkCommand(documentReferenceResponse)
   .timeToLive(Duration.ofHours(1))
   .send();
   

Specified by:

newCreateDocumentLinkCommand in interface CamundaClient

Parameters:

documentReference - the reference of the document

Returns:

a builder for the command

newDeleteDocumentCommand

public DeleteDocumentCommandStep1 newDeleteDocumentCommand(String documentId)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to update a document.

   camundaClient
   .newDeleteDocumentCommand(documentId)
   .storeId(storeId)
   .send();
   

Specified by:

newDeleteDocumentCommand in interface CamundaClient

Parameters:

documentId - the id of the document

Returns:

a builder for the command

newDeleteDocumentCommand

public DeleteDocumentCommandStep1 newDeleteDocumentCommand(DocumentReferenceResponse documentReference)

Description copied from interface: CamundaClient

Experimental: This method is under development. The respective API on compatible clusters cannot be considered production-ready. Thus, this method doesn't work out of the box with all clusters. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Command to update a document.

   camundaClient
   .newDeleteDocumentCommand(documentReferenceResponse)
   .send();
   

Specified by:

newDeleteDocumentCommand in interface CamundaClient

Parameters:

documentReference - the reference of the document

Returns:

a builder for the command

newCreateTenantCommand

public CreateTenantCommandStep1 newCreateTenantCommand()

Description copied from interface: CamundaClient

Command to create a tenant.

 camundaClient
  .newCreateTenantCommand()
  .tenantId("tenant-id")
  .name("Tenant Name")
  .send();
 

Specified by:

newCreateTenantCommand in interface CamundaClient

Returns:

a builder for the command

newUpdateTenantCommand

public UpdateTenantCommandStep1 newUpdateTenantCommand(String tenantId)

Description copied from interface: CamundaClient

Creates a command to update the name of an existing tenant.

Example usage:

 camundaClient
   .newUpdateTenantCommand("my-tenant-id") // Specify the tenant id
   .name("Updated Tenant Name")   // Set the new tenant name
   .send();                       // Send the command to the broker
 

Specified by:

newUpdateTenantCommand in interface CamundaClient

Parameters:

tenantId - the unique identifier of the tenant to be updated

Returns:

a builder to configure and send the update tenant command

newTenantGetRequest

public TenantGetRequest newTenantGetRequest(String tenantId)

Description copied from interface: CamundaClient

Request to get a tenant by tenant ID.

 camundaClient
  .newTenantGetRequest("tenantId")
  .send();
 

Specified by:

newTenantGetRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the request to get a tenant by ID

newTenantsSearchRequest

public TenantsSearchRequest newTenantsSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query tenants.

 camundaClient
  .newTenantsSearchRequest()
  .filter((f) -> f.name("tenantName"))
  .sort((s) -> s.name().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newTenantsSearchRequest in interface CamundaClient

Returns:

a builder for the tenants search request

newDeleteTenantCommand

public DeleteTenantCommandStep1 newDeleteTenantCommand(String tenantId)

Description copied from interface: CamundaClient

Command to delete a tenant.

 camundaClient
  .newDeleteTenantCommand(tenantId)
  .send();
 

Specified by:

newDeleteTenantCommand in interface CamundaClient

Parameters:

tenantId - the id of the tenant to delete

Returns:

a builder for the delete tenant command

newAssignMappingRuleToTenantCommand

public AssignMappingRuleToTenantCommandStep1 newAssignMappingRuleToTenantCommand()

Description copied from interface: CamundaClient

Command to assign a mapping rule to a tenant.

Example usage:

 camundaClient
   .newAssignMappingRuleToTenantCommand()
   .mappingRuleId("mappingRuleId")
   .tenantId("tenantId")
   .send();
 

This command sends an HTTP PUT request to assign the specified mapping rule to the given tenant.

Specified by:

newAssignMappingRuleToTenantCommand in interface CamundaClient

Returns:

a builder for the assign mapping rule to tenant command

newAssignUserToTenantCommand

public AssignUserToTenantCommandStep1 newAssignUserToTenantCommand()

Description copied from interface: CamundaClient

Command to assign a user to a tenant.

Example usage:

 camundaClient
   .newAssignUserToTenantCommand()
   .username(username)
   .tenantId(tenantId)
   .send();
 

This command sends an HTTP PUT request to assign the specified user to the given tenant.

Specified by:

newAssignUserToTenantCommand in interface CamundaClient

Returns:

a builder for the assign user to tenant command

newUnassignUserFromTenantCommand

public UnassignUserFromTenantCommandStep1 newUnassignUserFromTenantCommand()

Description copied from interface: CamundaClient

Command to unassign a user from a tenant.

Example usage:

 camundaClient
   .newUnassignUserFromTenantCommand()
   .username(username)
   .tenantId(tenantId)
   .send();
 

This command sends an HTTP DELETE request to unassign the specified user from the given tenant.

Specified by:

newUnassignUserFromTenantCommand in interface CamundaClient

Returns:

a builder for the unassign user from tenant command

newAssignGroupToTenantCommand

public AssignGroupToTenantCommandStep1 newAssignGroupToTenantCommand()

Description copied from interface: CamundaClient

Command to assign a group to a tenant.

Example usage:

 camundaClient
   .newAssignGroupToTenantCommand()
   .groupId("groupId")
   .tenantId("tenantId")
   .send();
 

Specified by:

newAssignGroupToTenantCommand in interface CamundaClient

Returns:

a builder to configure and send the assign group to tenant command

newUnassignGroupFromTenantCommand

public UnassignGroupFromTenantCommandStep1 newUnassignGroupFromTenantCommand()

Description copied from interface: CamundaClient

Command to unassign a group from a tenant.

Example usage:

 camundaClient
   .newUnassignGroupFromTenantCommand()
   .groupId("groupId")
   .tenantId("tenantId")
   .send();
 

Specified by:

newUnassignGroupFromTenantCommand in interface CamundaClient

Returns:

a builder to configure and send the unassign group from tenant command

newAssignClientToGroupCommand

public AssignClientToGroupCommandStep1 newAssignClientToGroupCommand()

Description copied from interface: CamundaClient

Command to assign a client to a group.

 camundaClient
  .newAssignClientToGroupCommand()
  .clientId("clientId")
  .groupId("groupId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignClientToGroupCommand in interface CamundaClient

Returns:

a builder to configure and send the assign client to group command

newUnassignClientFromGroupCommand

public UnassignClientFromGroupCommandStep1 newUnassignClientFromGroupCommand()

Description copied from interface: CamundaClient

Command to unassign a client from a group.

Example usage:

 camundaClient
   .newUnassignClientFromGroupCommand()
   .clientId("clientId")
   .groupId("groupId")
   .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignClientFromGroupCommand in interface CamundaClient

Returns:

a builder for the unassign client from group command

newAssignClientToTenantCommand

public AssignClientToTenantCommandStep1 newAssignClientToTenantCommand()

Description copied from interface: CamundaClient

Command to assign a client to a tenant.

 camundaClient
  .newAssignClientToTenantCommand()
  .clientId("clientId")
  .tenantId("tenantId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignClientToTenantCommand in interface CamundaClient

Returns:

a builder to configure and send the assign client to tenant command

newUnassignClientFromTenantCommand

public UnassignClientFromTenantCommandStep1 newUnassignClientFromTenantCommand()

Description copied from interface: CamundaClient

Command to unassign a client from a tenant.

 camundaClient
  .newUnassignClientFromTenantCommand()
  .clientId("clientId")
  .tenantId("tenantId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignClientFromTenantCommand in interface CamundaClient

Returns:

a builder to configure and send the unassign client from tenant command

newUnassignMappingRuleFromTenantCommand

public UnassignMappingRuleFromTenantCommandStep1 newUnassignMappingRuleFromTenantCommand()

Description copied from interface: CamundaClient

Command to unassign a mapping rule from a tenant.

 camundaClient
  .newUnassignMappingRuleFromTenantCommand()
  .mappingRuleId("mappingRuleId")
  .tenantId("tenantId")
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignMappingRuleFromTenantCommand in interface CamundaClient

Returns:

a builder to configure and send the unassign mapping rule from tenant command

newCreateAuthorizationCommand

public CreateAuthorizationCommandStep1 newCreateAuthorizationCommand()

Description copied from interface: CamundaClient

Command to create an authorization

Example usage:

 camundaClient
   .newCreateAuthorizationCommand()
   .ownerId(ownerId)
   .ownerType(ownerType)
   .resourceId(resourceId) // or .resourcePropertyName(resourcePropertyName)
   .resourceType(resourceType)
   .permission(PermissionType.READ)
   .send();
 

Specified by:

newCreateAuthorizationCommand in interface CamundaClient

Returns:

a builder to configure and send the create authorization command

newAuthorizationGetRequest

public AuthorizationGetRequest newAuthorizationGetRequest(long authorizationKey)

Description copied from interface: CamundaClient

Request to get an authorization by authorization key.

 camundaClient
  .newAuthorizationGetRequest(authorizationKey)
  .send();
 

Specified by:

newAuthorizationGetRequest in interface CamundaClient

Parameters:

authorizationKey - the authorizationKey of the authorization

Returns:

a builder for the request to get an authorization

newAuthorizationSearchRequest

public AuthorizationsSearchRequest newAuthorizationSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query authorizations.

 camundaClient
  .newAuthorizationSearchRequest()
  .filter((f) -> f.ownerType("ownerType"))
  .sort((s) -> s.ownerId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newAuthorizationSearchRequest in interface CamundaClient

Returns:

a builder for the authorizations search request

newDeleteAuthorizationCommand

public DeleteAuthorizationCommandStep1 newDeleteAuthorizationCommand(long authorizationKey)

Description copied from interface: CamundaClient

Command to delete an authorization

Example usage:

 camundaClient
   .newDeleteAuthorizationCommand(authorizationKey)
   .send();
 

Specified by:

newDeleteAuthorizationCommand in interface CamundaClient

Parameters:

authorizationKey - the key of the authorization to delete

Returns:

a builder to configure and send the delete authorization command

newUpdateAuthorizationCommand

public UpdateAuthorizationCommandStep1 newUpdateAuthorizationCommand(long authorizationKey)

Description copied from interface: CamundaClient

Command to update an authorization

Example usage:

 camundaClient
   .newUpdateAuthorizationCommand(authorizationKey)
   .ownerId(ownerId)
   .ownerType(ownerType)
   .resourceId(resourceId) // or .resourcePropertyName(resourcePropertyName)
   .resourceType(resourceType)
   .permissionTypes(Set.of(PermissionType.READ))
   .send();
 

Specified by:

newUpdateAuthorizationCommand in interface CamundaClient

Parameters:

authorizationKey - the key of the authorization to update

Returns:

a builder to configure and send the update authorization command

newCreateBatchOperationCommand

public CreateBatchOperationCommandStep1 newCreateBatchOperationCommand()

Description copied from interface: CamundaClient

Command to create a batch operation

Example usage:

 camundaClient
   .newCreateBatchOperationCommand()
   .processInstanceCancel()
   .filter(filter)
   .send();
 

Specified by:

newCreateBatchOperationCommand in interface CamundaClient

Returns:

a builder to configure and send the create batch operation command

newBatchOperationGetRequest

public BatchOperationGetRequest newBatchOperationGetRequest(String batchOperationKey)

Description copied from interface: CamundaClient

Request to get a single batch operation by batch operation key.

 camundaClient
  .newBatchOperationGetRequest(batchOperationKey)
  .send();
 

Specified by:

newBatchOperationGetRequest in interface CamundaClient

Parameters:

batchOperationKey - the key which identifies the corresponding batch operation

Returns:

a builder for the request

newBatchOperationSearchRequest

public BatchOperationSearchRequest newBatchOperationSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query batch operations.

 camundaClient
  .newBatchOperationSearchRequest()
  .filter((f) -> f.state(state))
  .sort((s) -> s.startDate().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newBatchOperationSearchRequest in interface CamundaClient

Returns:

a builder for the groups search request

newCancelBatchOperationCommand

public CancelBatchOperationStep1 newCancelBatchOperationCommand(String batchOperationKey)

Description copied from interface: CamundaClient

Command to cancel a batch operation

Example usage:

 camundaClient
   .newCancelBatchOperationCommand("123")
   .send();
 

Specified by:

newCancelBatchOperationCommand in interface CamundaClient

Returns:

a builder to configure and send the cancel batch operation command

newSuspendBatchOperationCommand

public SuspendBatchOperationStep1 newSuspendBatchOperationCommand(String batchOperationKey)

Description copied from interface: CamundaClient

Command to suspend a batch operation

Example usage:

 camundaClient
   .newSuspendBatchOperationCommand("123L")
   .send();
 

Specified by:

newSuspendBatchOperationCommand in interface CamundaClient

Returns:

a builder to configure and send the suspend batch operation command

newResumeBatchOperationCommand

public ResumeBatchOperationStep1 newResumeBatchOperationCommand(String batchOperationKey)

Description copied from interface: CamundaClient

Command to resume a batch operation

Example usage:

 camundaClient
   .newResumeBatchOperationCommand("123L")
   .send();
 

Specified by:

newResumeBatchOperationCommand in interface CamundaClient

Returns:

a builder to configure and send the resume batch operation command

newBatchOperationItemsSearchRequest

public BatchOperationItemSearchRequest newBatchOperationItemsSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query batch operation items.

 camundaClient
  .newBatchOperationItemSearchRequest()
  .filter((f) -> f.state(state))
  .sort((s) -> s.itemKey().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newBatchOperationItemsSearchRequest in interface CamundaClient

Returns:

a builder for the groups search request

newAssignMappingRuleToGroupCommand

public AssignMappingRuleToGroupStep1 newAssignMappingRuleToGroupCommand()

Description copied from interface: CamundaClient

Command to assign a mapping rule to a group.

 camundaClient
  .newAssignMappingRuleToGroupCommand()
  .mappingRuleId(mappingRuleId)
  .groupId(groupId)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newAssignMappingRuleToGroupCommand in interface CamundaClient

Returns:

a builder for the command

newUnassignMappingRuleFromGroupCommand

public UnassignMappingRuleFromGroupStep1 newUnassignMappingRuleFromGroupCommand()

Description copied from interface: CamundaClient

Command to unassign a mapping rule from a group.

 camundaClient
  .newUnassignMappingRuleFromGroupCommand()
  .mappingRuleId(mappingRuleId)
  .groupId(groupId)
  .send();
 

This command is only sent via REST over HTTP, not via gRPC

Specified by:

newUnassignMappingRuleFromGroupCommand in interface CamundaClient

Returns:

a builder for the command

newGroupGetRequest

public GroupGetRequest newGroupGetRequest(String groupId)

Description copied from interface: CamundaClient

Request to get a group by group ID.

 camundaClient
  .newGroupGetRequest(groupId)
  .send();
 

Specified by:

newGroupGetRequest in interface CamundaClient

Parameters:

groupId - the ID of the group

Returns:

a builder for the request to get a group

newGroupsSearchRequest

public GroupsSearchRequest newGroupsSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query groups.

 camundaClient
  .newGroupsSearchRequest()
  .filter((f) -> f.name(name))
  .sort((s) -> s.name().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newGroupsSearchRequest in interface CamundaClient

Returns:

a builder for the groups search request

newUsersByGroupSearchRequest

public UsersByGroupSearchRequest newUsersByGroupSearchRequest(String groupId)

Description copied from interface: CamundaClient

Executes a search request to query users by group.

 camundaClient
  .newUsersByGroupSearchRequest(groupId)
  .sort((s) -> s.username().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newUsersByGroupSearchRequest in interface CamundaClient

Returns:

a builder for the users by group search request

newProcessInstanceGetCallHierarchyRequest

public ProcessInstanceGetCallHierarchyRequest newProcessInstanceGetCallHierarchyRequest(Long processInstanceKey)

Description copied from interface: CamundaClient

Retrieves the call hierarchy for a given process instance by its key.

 camundaClient
   .newProcessInstanceGetCallHierarchyRequest(processInstanceKey)
   .send();
 

The returned hierarchical structure represents the relationship of the given process instance to its parent and child process instances, if any.

Specified by:

newProcessInstanceGetCallHierarchyRequest in interface CamundaClient

Parameters:

processInstanceKey - the key of the process instance

Returns:

a builder for the request

newMappingRulesByGroupSearchRequest

public MappingRulesByGroupSearchRequest newMappingRulesByGroupSearchRequest(String groupId)

Description copied from interface: CamundaClient

Executes a search request to query mapping rules by group.

   camundaClient
    .newMappingRulesByGroupSearchRequest(groupId)
    .filter((f) -> f.mappingRuleId(mappingRuleId))
    .sort((s) -> s.mappingRuleId().asc())
    .page((p) -> p.limit(100))
    .send();
 

Specified by:

newMappingRulesByGroupSearchRequest in interface CamundaClient

Parameters:

groupId - the ID of the group

Returns:

a builder for the mapping rules by group search request

newMappingRulesByRoleSearchRequest

public MappingRulesByRoleSearchRequest newMappingRulesByRoleSearchRequest(String roleId)

Description copied from interface: CamundaClient

Executes a search request to query mapping rules by role.

 camundaClient
  .newMappingRulesByRoleSearchRequest("roleId")
  .filter((f) -> f.mappingRuleId("mapping-rule-123"))
  .sort((s) -> s.mappingRuleId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newMappingRulesByRoleSearchRequest in interface CamundaClient

Parameters:

roleId - the ID of the role

Returns:

a builder for the mapping rules by role search request

newMappingRulesByTenantSearchRequest

public MappingRulesByTenantSearchRequest newMappingRulesByTenantSearchRequest(String tenantId)

Description copied from interface: CamundaClient

Executes a search request to query mapping rules by tenant.

 camundaClient
  .newMappingRulesByTenantSearchRequest("tenantId")
  .filter((f) -> f.mappingRuleId("mapping-rule-123"))
  .sort((s) -> s.mappingRuleId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newMappingRulesByTenantSearchRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the mapping rules by tenant search request

newMappingRulesSearchRequest

public MappingRulesSearchRequest newMappingRulesSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query mapping rules.

 camundaClient
  .newMappingRulesSearchRequest()
  .filter((f) -> f.mappingRuleId("mapping-rule-123"))
  .sort((s) -> s.mappingRuleId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newMappingRulesSearchRequest in interface CamundaClient

Returns:

a builder for the mapping rules search request

newRolesByGroupSearchRequest

public RolesByGroupSearchRequest newRolesByGroupSearchRequest(String groupId)

Description copied from interface: CamundaClient

Executes a search request to query roles by group.

   camundaClient
    .newRolesByGroupSearchRequest(groupId)
    .filter((f) -> f.roleName(roleName))
    .sort((s) -> s.roleName().asc())
    .page((p) -> p.limit(100))
    .send();
  

Specified by:

newRolesByGroupSearchRequest in interface CamundaClient

Parameters:

groupId - the ID of the group

Returns:

a builder for the roles by group search request

newIncidentsByProcessInstanceSearchRequest

public IncidentsByProcessInstanceSearchRequest newIncidentsByProcessInstanceSearchRequest(long processInstanceKey)

Description copied from interface: CamundaClient

Executes a search request to query incidents by process instance key.

   camundaClient
    .newIncidentSearchByProcessInstanceKey(processInstanceKey)
    .sort((s) -> s.incidentKey().desc())
    .page((p) -> p.limit(100))
    .send();
 

Specified by:

newIncidentsByProcessInstanceSearchRequest in interface CamundaClient

newGroupsByRoleSearchRequest

public GroupsByRoleSearchRequest newGroupsByRoleSearchRequest(String roleId)

Description copied from interface: CamundaClient

Executes a search request to query groups by role.

 camundaClient
  .newGroupsByRoleSearchRequest("roleId")
  .sort((s) -> s.groupdId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newGroupsByRoleSearchRequest in interface CamundaClient

Parameters:

roleId - the ID of the role

Returns:

a builder for the groups by role search request

newGroupsByTenantSearchRequest

public GroupsByTenantSearchRequest newGroupsByTenantSearchRequest(String tenantId)

Description copied from interface: CamundaClient

Executes a search request to query groups by tenant.

 camundaClient
  .newGroupsByTenantSearchRequest("tenantId")
  .sort((s) -> s.groupId().desc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newGroupsByTenantSearchRequest in interface CamundaClient

Parameters:

tenantId - the ID of the tenant

Returns:

a builder for the groups by tenant search request

newJobSearchRequest

public JobSearchRequest newJobSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query jobs.

 camundaClient
  .newJobSearchRequest()
  .filter((f) -> f.jobKey(userTaskKey))
  .sort((s) -> s.endTime.asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newJobSearchRequest in interface CamundaClient

Returns:

a builder for the job search request

newMessageSubscriptionSearchRequest

public MessageSubscriptionSearchRequest newMessageSubscriptionSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query message subscriptions.

 camundaClient
  .newMessageSubscriptionSearchRequest()
  .filter((f) -> f.messageSubscriptionKey(messageSubscriptionKey))
  .sort((s) -> s.messageName().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newMessageSubscriptionSearchRequest in interface CamundaClient

Returns:

a builder for the message subscription search request

newCorrelatedMessageSubscriptionSearchRequest

public CorrelatedMessageSubscriptionSearchRequest newCorrelatedMessageSubscriptionSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query correlated message subscriptions.

 camundaClient
  .newCorrelatedMessageSubscriptionSearchRequest()
  .filter((f) -> f.messageName("myMessage"))
  .sort((s) -> s.correlationTime().desc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newCorrelatedMessageSubscriptionSearchRequest in interface CamundaClient

Returns:

a builder for the correlated message subscription search request

newIncidentsByElementInstanceSearchRequest

public IncidentsByElementInstanceSearchRequest newIncidentsByElementInstanceSearchRequest(long elementInstanceKey)

Description copied from interface: CamundaClient

Executes a search request to query incidents by element instance key.

   camundaClient
    .newIncidentsByElementInstanceSearchRequest(elementInstanceKey)
    .sort((s) -> s.incidentKey().desc())
    .page((p) -> p.limit(100))
    .send();
 

Specified by:

newIncidentsByElementInstanceSearchRequest in interface CamundaClient

Parameters:

elementInstanceKey - the key of the element instance

Returns:

a builder for the incidents by element instance search request

newAuditLogGetRequest

public AuditLogGetRequest newAuditLogGetRequest(String auditLogKey)

Description copied from interface: CamundaClient

Request to get an audit log by audit log key.

   camundaClient
    .newAuditLogGetRequest(auditLogKey)
    .send();
 

Specified by:

newAuditLogGetRequest in interface CamundaClient

Parameters:

auditLogKey - the key that identifies the corresponding audit log

Returns:

a builder for the audit log request

newAuditLogSearchRequest

public AuditLogSearchRequest newAuditLogSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query audit logs by the audit log key.

   camundaClient
    .newAuditLogSearchRequest()
    .filter((f) -> f.processInstanceKey("myProcessInstanceKey"))
    .sort((s) -> s.processDefinitionId().desc())
    .page((p) -> p.limit(100))
    .send();
 

Specified by:

newAuditLogSearchRequest in interface CamundaClient

Returns:

a builder for the incidents by element instance search request

newElementInstanceWaitStateSearchRequest

public ElementInstanceWaitStateSearchRequest newElementInstanceWaitStateSearchRequest()

Description copied from interface: CamundaClient

Executes a search request to query element instance wait states.

   camundaClient
    .newElementInstanceWaitStateSearchRequest()
    .filter((f) -> f.processInstanceKey(myProcessInstanceKey))
    .page((p) -> p.limit(100))
    .send();
 

Specified by:

newElementInstanceWaitStateSearchRequest in interface CamundaClient

Returns:

a builder for the element instance wait state search request

newUserTaskAuditLogSearchRequest

public UserTaskAuditLogSearchRequest newUserTaskAuditLogSearchRequest(long userTaskKey)

Description copied from interface: CamundaClient

Executes a search request to query audit logs related to a user task.

   long userTaskKey = ...;

  camundaClient
   .newUserTaskAuditLogSearchRequest(userTaskKey)
   .filter((f) -> f.actorId("actorId"))
   .sort((s) -> s.timestamp().desc())
   .page((p) -> p.limit(100))
   .send();
 

Specified by:

newUserTaskAuditLogSearchRequest in interface CamundaClient

Parameters:

userTaskKey - the key of the user task

Returns:

a builder for the user task audit log search request

newProcessDefinitionInstanceStatisticsRequest

public ProcessDefinitionInstanceStatisticsRequest newProcessDefinitionInstanceStatisticsRequest()

Description copied from interface: CamundaClient

Get statistics about process instances, grouped by process definition and tenant.

  camundaClient
  .newProcessDefinitionInstanceStatisticsRequest()
  .sort((s) -> s.processDefinitionId().asc())
  .page((p) -> p.limit(100))
  .send();
 

Specified by:

newProcessDefinitionInstanceStatisticsRequest in interface CamundaClient

Returns:

a builder for the process definition instance statistics request

newProcessDefinitionInstanceVersionStatisticsRequest

public ProcessDefinitionInstanceVersionStatisticsRequest newProcessDefinitionInstanceVersionStatisticsRequest(String processDefinitionId)

Description copied from interface: CamundaClient

Get statistics about process instances, grouped by version for a given process definition.

    camundaClient
    .newProcessDefinitionInstanceVersionStatisticsRequest(processDefinitionId)
    .filter((f) -> f.tenantId("tenantId"))
    .sort((s) -> s.processDefinitionVersion().asc())
    .page((p) -> p.limit(100))
    .send();
  

Specified by:

newProcessDefinitionInstanceVersionStatisticsRequest in interface CamundaClient

Parameters:

processDefinitionId - the id of the process definition

Returns:

a builder for the process definition version instance statistics request

newEvaluateConditionalCommand

public EvaluateConditionalCommandStep1 newEvaluateConditionalCommand()

Description copied from interface: CamundaClient

Command to evaluate root-level conditional start events for process definitions.

 camundaClient
  .newEvaluateConditionalCommand()
  .variables(json)
  .send();

 // Or for a specific process definition and tenant:
 camundaClient
  .newEvaluateConditionalCommand()
  .variables(json)
  .processDefinitionKey(12345L)
  .tenantId("tenant-1")
  .send();
 

Specified by:

newEvaluateConditionalCommand in interface CamundaClient

Returns:

a builder for the request to evaluate root-level conditional start events

newIncidentProcessInstanceStatisticsByErrorRequest

public IncidentProcessInstanceStatisticsByErrorRequest newIncidentProcessInstanceStatisticsByErrorRequest()

Description copied from interface: CamundaClient

Retrieves statistics about active process instances that currently have active incidents, grouped by incident error hash code.

 camundaClient
  .newIncidentProcessInstanceStatisticsByErrorRequest()
  .page(p -> p.limit(50))
  .sort(s -> s.activeInstancesWithErrorCount().desc())
  .send();
 

Specified by:

newIncidentProcessInstanceStatisticsByErrorRequest in interface CamundaClient

Returns:

a builder for querying process instance statistics grouped by incident error

newEvaluateExpressionCommand

public EvaluateExpressionCommandStep1 newEvaluateExpressionCommand()

Description copied from interface: CamundaClient

Command to evaluate an expression.

 camundaClient
  .newEvaluateExpressionCommand()
  .expression("=x + y")
  .tenantId("tenant_123")
  .send();
 

Specified by:

newEvaluateExpressionCommand in interface CamundaClient

Returns:

a builder for the command

newIncidentProcessInstanceStatisticsByDefinitionRequest

public IncidentProcessInstanceStatisticsByDefinitionRequest newIncidentProcessInstanceStatisticsByDefinitionRequest(int errorHashCode)

Description copied from interface: CamundaClient

Executes a statistics request that returns counts of active process instances with active incidents, grouped by process definition.

The statistics are scoped to a specific incident error and therefore require an error hash code to be provided.

Each result item represents a single process definition (including version and tenant) and contains the number of active process instances that currently have an incident with the given error hash code.

 camundaClient
  .newIncidentProcessInstanceStatisticsByDefinitionRequest(errorHashCode)
  .page(p -> p.limit(50))
  .sort(s -> s.activeInstancesWithErrorCount().desc())
  .send();
 

Specified by:

newIncidentProcessInstanceStatisticsByDefinitionRequest in interface CamundaClient

Parameters:

errorHashCode - the error hash code to filter the incidents by

Returns:

a builder for the incident process instance statistics request grouped by definition

newResourceGetRequest

public ResourceGetRequest newResourceGetRequest(long resourceKey)

Description copied from interface: CamundaClient

Retrieves a resource by key.

 long resourceKey = ...;

 camundaClient
  .newResourceGetRequest(resourceKey)
  .send();
 

Specified by:

newResourceGetRequest in interface CamundaClient

Returns:

a builder for the request to get a resource

newResourceContentGetRequest

public ResourceContentGetRequest newResourceContentGetRequest(long resourceKey)

Description copied from interface: CamundaClient

Retrieves a resource content by key.

 long resourceKey = ...;

 camundaClient
  .newResourceContentGetRequest(resourceKey)
  .send();
 

Specified by:

newResourceContentGetRequest in interface CamundaClient

Returns:

a builder for the request to get an RPA resource content as JSON

newResourceContentBinaryGetRequest

public ResourceContentGetRequest newResourceContentBinaryGetRequest(long resourceKey)

Description copied from interface: CamundaClient

Retrieves a resource content as binary by key.

 long resourceKey = ...;

 camundaClient
  .newResourceContentBinaryGetRequest(resourceKey)
  .send();
 

Specified by:

newResourceContentBinaryGetRequest in interface CamundaClient

Returns:

a builder for the request to get a resource content as binary

newCreateAgentHistoryItemCommand

public CreateAgentHistoryItemCommandStep1 newCreateAgentHistoryItemCommand(long agentInstanceKey)

Description copied from interface: CamundaClient

Creates a command to append a conversation history item to an agent instance.

   CreateAgentHistoryItemResponse response = camundaClient
       .newCreateAgentHistoryItemCommand(agentInstanceKey)
       .elementInstanceKey(elementInstanceKey)
       .jobKey(jobKey)
       .jobLease(jobLease)
       .role(AgentInstanceHistoryRole.ASSISTANT)
       .content(contentList)
       .producedAt(OffsetDateTime.now())
       .send()
       .join();
 

Specified by:

newCreateAgentHistoryItemCommand in interface CamundaClient

Parameters:

agentInstanceKey - the key of the agent instance

Returns:

a builder for creating an agent history item

newCreateAgentInstanceCommand

public CreateAgentInstanceCommandStep1 newCreateAgentInstanceCommand()

Description copied from interface: CamundaClient

Creates a command to create a new agent instance.

   CreateAgentInstanceResponse response = camundaClient
       .newCreateAgentInstanceCommand()
       .elementInstanceKey(2251799813685248)
       .model("gpt-4o")
       .provider("openai")
       .systemPrompt("You are a helpful assistant.")
       .send()
       .join();
 

Specified by:

newCreateAgentInstanceCommand in interface CamundaClient

Returns:

a builder for creating an agent instance

newUpdateAgentInstanceCommand

public UpdateAgentInstanceCommandStep1 newUpdateAgentInstanceCommand(long agentInstanceKey)

Description copied from interface: CamundaClient

Creates a command to update an existing agent instance.

   camundaClient
       .newUpdateAgentInstanceCommand(agentInstanceKey)
       .elementInstanceKey(elementInstanceKey)
       .status(AgentInstanceUpdateStatus.THINKING)
       .send()
       .join();
 

Specified by:

newUpdateAgentInstanceCommand in interface CamundaClient

Parameters:

agentInstanceKey - the key of the agent instance to update

Returns:

a builder for updating the agent instance

newCreateGlobalTaskListenerRequest

public CreateGlobalTaskListenerCommandStep1 newCreateGlobalTaskListenerRequest()

Description copied from interface: CamundaClient

Creates a request to create a new global task listener.

   GlobalTaskListenerResponse response = camundaClient
       .newCreateGlobalTaskListenerRequest()
       .id("my-listener")
       .type("my-job-type")
       .eventTypes(GlobalTaskListenerEventType.ALL)
       .send()
       .join();
 

Specified by:

newCreateGlobalTaskListenerRequest in interface CamundaClient

Returns:

a builder for creating a global task listener

newUpdateGlobalTaskListenerRequest

public UpdateGlobalTaskListenerCommandStep1 newUpdateGlobalTaskListenerRequest(String id)

Description copied from interface: CamundaClient

Creates a request to update an existing global task listener.

   GlobalTaskListenerResponse response = camundaClient
       .newUpdateGlobalTaskListenerRequest("my-listener")
       .type("my-job-type")
       .eventTypes(GlobalTaskListenerEventType.ALL)
       .send()
       .join();
 

Specified by:

newUpdateGlobalTaskListenerRequest in interface CamundaClient

Parameters:

id - the id of the global listener to update

Returns:

a builder for updating a global task listener

newDeleteGlobalTaskListenerRequest

public DeleteGlobalTaskListenerCommandStep1 newDeleteGlobalTaskListenerRequest(String id)

Description copied from interface: CamundaClient

Creates a request to delete a global task listener.

   camundaClient
       .newDeleteGlobalTaskListenerRequest("my-listener")
       .send();
 

Specified by:

newDeleteGlobalTaskListenerRequest in interface CamundaClient

Parameters:

id - the id of the global listener to delete

Returns:

a builder for deleting a global task listener

newGlobalTaskListenerGetRequest

public GlobalTaskListenerGetRequest newGlobalTaskListenerGetRequest(String id)

Description copied from interface: CamundaClient

Creates a request to fetch a global task listener by id.

   camundaClient
       .newGlobalTaskListenerGetRequest("my-listener")
       .send();
 

Specified by:

newGlobalTaskListenerGetRequest in interface CamundaClient

Returns:

a builder for fetching a global task listener

newGlobalTaskListenerSearchRequest

public GlobalTaskListenerSearchRequest newGlobalTaskListenerSearchRequest()

Description copied from interface: CamundaClient

Creates a request to search for global task listeners.

Global task listeners can be searched with filtering and sorting capabilities:

   camundaClient
       .newGlobalTaskListenerSearchRequest()
       .filter(f -> f.source(GlobalListenerSource.CONFIGURATION))
       .sort(s -> s.priority().desc())
       .send();
 

Specified by:

newGlobalTaskListenerSearchRequest in interface CamundaClient

Returns:

a builder for searching global task listeners

newAgentInstanceGetRequest

public AgentInstanceGetRequest newAgentInstanceGetRequest(long agentInstanceKey)

Description copied from interface: CamundaClient

Creates a request to fetch an agent instance by its key.

   camundaClient
       .newAgentInstanceGetRequest(agentInstanceKey)
       .send();
 

Specified by:

newAgentInstanceGetRequest in interface CamundaClient

Parameters:

agentInstanceKey - the key of the agent instance to retrieve

Returns:

a builder for fetching an agent instance

newAgentInstanceSearchRequest

public AgentInstanceSearchRequest newAgentInstanceSearchRequest()

Description copied from interface: CamundaClient

Creates a request to search for agent instances.

Agent instances can be searched with filtering and sorting capabilities:

   camundaClient
       .newAgentInstanceSearchRequest()
       .filter(f -> f.status(AgentInstanceStatus.COMPLETED))
       .sort(s -> s.creationDate().desc())
       .send();
 

Specified by:

newAgentInstanceSearchRequest in interface CamundaClient

Returns:

a builder for searching agent instances

newAgentInstanceHistorySearchRequest

public AgentInstanceHistorySearchRequest newAgentInstanceHistorySearchRequest(long agentInstanceKey)

Description copied from interface: CamundaClient

Creates a request to search the conversation history of an agent instance.

   camundaClient
       .newAgentInstanceHistorySearchRequest(agentInstanceKey)
       .filter(f -> f.role(AgentInstanceHistoryRole.USER))
       .sort(s -> s.producedAt().asc())
       .send();
 

Specified by:

newAgentInstanceHistorySearchRequest in interface CamundaClient

Parameters:

agentInstanceKey - the key of the agent instance whose history to search

Returns:

a builder for searching agent instance history

newCompleteCommand

public CompleteJobCommandStep1 newCompleteCommand(long jobKey)

Description copied from interface: JobClient

Command to complete a job.

 long jobKey = ..;

 jobClient
  .newCompleteCommand(jobKey)
  .variables(json)
  .send();
 

If the job is linked to a process instance then this command will complete the related activity and continue the flow.

Specified by:

newCompleteCommand in interface JobClient

Parameters:

jobKey - the key which identifies the job

Returns:

a builder for the command

newCompleteCommand

public CompleteJobCommandStep1 newCompleteCommand(ActivatedJob job)

Description copied from interface: JobClient

Command to complete a job.

 ActivatedJob job = ..;

 jobClient
  .newCompleteCommand(job)
  .variables(json)
  .send();
 

If the job is linked to a process instance then this command will complete the related activity and continue the flow.

Specified by:

newCompleteCommand in interface JobClient

Parameters:

job - the activated job

Returns:

a builder for the command

newFailCommand

public FailJobCommandStep1 newFailCommand(long jobKey)

Description copied from interface: JobClient

Command to mark a job as failed.

 long jobKey = ..;

 jobClient
  .newFailCommand(jobKey)
  .retries(3)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job subscription. Otherwise, an incident is created for this job.

Specified by:

newFailCommand in interface JobClient

Parameters:

jobKey - the key which identifies the job

Returns:

a builder for the command

newFailCommand

public FailJobCommandStep1 newFailCommand(ActivatedJob job)

Description copied from interface: JobClient

Command to mark a job as failed.

 ActivatedJob job = ..;

 jobClient
  .newFailCommand(job)
  .retries(3)
  .send();
 

If the given retries are greater than zero then this job will be picked up again by a job subscription. Otherwise, an incident is created for this job.

Specified by:

newFailCommand in interface JobClient

Parameters:

job - the activated job

Returns:

a builder for the command

newThrowErrorCommand

public ThrowErrorCommandStep1 newThrowErrorCommand(long jobKey)

Description copied from interface: JobClient

Command to report a business error (i.e. non-technical) that occurs while processing a job.

 long jobKey = ...;
 String code = ...;

 jobClient
  .newThrowErrorCommand(jobKey)
  .errorCode(code)
  .send();
 

The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.

Specified by:

newThrowErrorCommand in interface JobClient

Parameters:

jobKey - the key which identifies the job

Returns:

a builder for the command

newThrowErrorCommand

public ThrowErrorCommandStep1 newThrowErrorCommand(ActivatedJob job)

Description copied from interface: JobClient

Command to report a business error (i.e. non-technical) that occurs while processing a job.

 ActivatedJob job = ...;
 String code = ...;

 jobClient
  .newThrowErrorCommand(job)
  .errorCode(code)
  .send();
 

The error is handled in the process by an error catch event. If there is no error catch event with the specified errorCode then an incident will be raised instead.

Specified by:

newThrowErrorCommand in interface JobClient

Parameters:

job - the activated job

Returns:

a builder for the command

newActivateJobsCommand

public ActivateJobsCommandStep1 newActivateJobsCommand()

Description copied from interface: JobClient

Command to activate multiple jobs of a given type.

 jobClient
  .newActivateJobsCommand()
  .jobType("payment")
  .maxJobsToActivate(10)
  .workerName("paymentWorker")
  .timeout(Duration.ofMinutes(10))
  .send();
 

The command will try to use maxJobsToActivate for given jobType. If less then the requested maxJobsToActivate jobs of the jobType are available for activation the returned list will have fewer elements.

Specified by:

newActivateJobsCommand in interface JobClient

Returns:

a builder for the command

newStreamJobsCommand

public StreamJobsCommandStep1 newStreamJobsCommand()

Description copied from interface: JobClient

Activates and streams jobs of a specific type.

This command will always try to use the gRPC communication protocol, even if the client is configured to prefer REST (streaming over REST is not supported).

 final Consumer<ActivatedJob> consumer = ...; // do something with the consumed job
 final CamundaFuture<StreamJobsResponse> stream = jobClient
  .newStreamJobsCommand()
  .jobType("payment")
  .consumer(consumer)
  .workerName("paymentWorker")
  .timeout(Duration.ofMinutes(10))
  .send();

  stream.whenComplete((ok, error) -> {
    // recreate stream if necessary
    // be careful if you've cancelled the stream explicitly to not recreate it if shutting down
  });

  // You can later terminate the stream by cancelling the future
  stream.cancel(true);
 

Stream or Activate?

As opposed to JobClient.newActivateJobsCommand(), which polls each partition until it has activated enough jobs or a timeout has elapsed, this command opens a long living stream onto which activated jobs are pushed. This typically results in lower latency, as jobs are activated and pushed out immediately, instead of waiting to be polled.

Limitations

There is currently no way to rate limit how many jobs are streamed over a single call. This can be mitigated by opening more streams of the same type, which will ensure work is fairly load balanced.

Additionally, only jobs which are created, retried, or timed out after the command has been registered will be streamed out. For older jobs, you must still use the JobClient.newActivateJobsCommand(). It's generally recommended that you use the JobWorker API to avoid having to coordinate both calls.

Activation

Jobs activated via this command will use the given worker name, activation time out, and fetch variables parameters in the same way as the JobClient.newActivateJobsCommand().

Termination

The stream can be explicitly cancelled by performing one of the following:

• Closing the Camunda client
• Cancelling the result of FinalCommandStep.send() via Future.cancel(boolean) (the argument is irrelevant)
• Setting a FinalCommandStep.requestTimeout(Duration); the stream will be closed once this time out is reached. By default, there is no request time out at all. It's recommended to assign a long-ish time out and recreate your streams from time to time to ensure good load balancing across gateways.

NOTE: streams can be closed for various reasons - for example, the server is restarting. As such, it's recommended to add listeners to the resulting future to handle such cases and reopen streams if necessary.

Specified by:

newStreamJobsCommand in interface JobClient

Returns:

a builder for the command