Interface JobClient
- All Known Subinterfaces:
ZeebeClient
- All Known Implementing Classes:
JobClientImpl
,ZeebeClientImpl
-
Method Summary
Modifier and TypeMethodDescriptionnewCompleteCommand
(long jobKey) Command to complete a job.Command to complete a job.newFailCommand
(long jobKey) Command to mark a job as failed.Command to mark a job as failed.newThrowErrorCommand
(long jobKey) Command to report a business error (i.e.Command to report a business error (i.e.
-
Method Details
-
newCompleteCommand
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.
- Parameters:
jobKey
- the key which identifies the job- Returns:
- a builder for the command
-
newCompleteCommand
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.
- Parameters:
job
- the activated job- Returns:
- a builder for the command
-
newFailCommand
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.
- Parameters:
jobKey
- the key which identifies the job- Returns:
- a builder for the command
-
newFailCommand
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.
- Parameters:
job
- the activated job- Returns:
- a builder for the command
-
newThrowErrorCommand
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.
- Parameters:
jobKey
- the key which identifies the job- Returns:
- a builder for the command
-
newThrowErrorCommand
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.
- Parameters:
job
- the activated job- Returns:
- a builder for the command
-