Package io.camunda.zeebe.client.api.worker

Interface JobClient

All Known Subinterfaces:
ZeebeClient
All Known Implementing Classes:
JobClientImpl, ZeebeClientImpl
public interface JobClient
A client with access to all job-related operation:
  • complete a job
  • mark a job as failed
  • update the retries of a job

    • Method Details

      • newCompleteCommand

        CompleteJobCommandStep1 newCompleteCommand(long jobKey)
        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

        CompleteJobCommandStep1 newCompleteCommand(ActivatedJob job)
        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

        FailJobCommandStep1 newFailCommand(long jobKey)
        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

        FailJobCommandStep1 newFailCommand(ActivatedJob job)
        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

        ThrowErrorCommandStep1 newThrowErrorCommand(long jobKey)
        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

        ThrowErrorCommandStep1 newThrowErrorCommand(ActivatedJob job)
        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