Package io.zeebe.client.impl.worker

Class JobClientImpl

java.lang.Object

io.zeebe.client.impl.worker.JobClientImpl

All Implemented Interfaces:

JobClient

public final class JobClientImpl
extends Object
implements JobClient

Constructor Summary

Constructors

Constructor	Description
JobClientImpl(GatewayGrpc.GatewayStub asyncStub, ZeebeClientConfiguration config, ZeebeObjectMapper objectMapper, Predicate<Throwable> retryPredicate)

Method Summary

Modifier and Type	Method	Description
CompleteJobCommandStep1	newCompleteCommand(long jobKey)	Command to complete a job.
FailJobCommandStep1	newFailCommand(long jobKey)	Command to mark a job as failed.
ThrowErrorCommandStep1	newThrowErrorCommand(long jobKey)	Command to report a business error (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobClientImpl

public JobClientImpl(GatewayGrpc.GatewayStub asyncStub,
                     ZeebeClientConfiguration config,
                     ZeebeObjectMapper objectMapper,
                     Predicate<Throwable> retryPredicate)

Method Detail

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 workflow 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

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

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 workflow 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