Package io.camunda.zeebe.client.impl.command

Class FailJobCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.CommandWithVariables<FailJobCommandStep1.FailJobCommandStep2>

io.camunda.zeebe.client.impl.command.FailJobCommandImpl

All Implemented Interfaces:

CommandWithCommunicationApiStep<FailJobCommandStep1>, FailJobCommandStep1, FailJobCommandStep1.FailJobCommandStep2, FinalCommandStep<FailJobResponse>

public final class FailJobCommandImpl
extends CommandWithVariables<FailJobCommandStep1.FailJobCommandStep2>
implements FailJobCommandStep1, FailJobCommandStep1.FailJobCommandStep2

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.zeebe.client.api.command.FailJobCommandStep1

FailJobCommandStep1.FailJobCommandStep2

Field Summary

Fields inherited from class io.camunda.zeebe.client.impl.command.CommandWithVariables

objectMapper

Constructor Summary

Constructors

Constructor	Description
FailJobCommandImpl(GatewayGrpc.GatewayStub asyncStub, JsonMapper jsonMapper, long key, Duration requestTimeout, Predicate<CredentialsProvider.StatusCode> retryPredicate, HttpClient httpClient, boolean preferRestOverGrpc)

Method Summary

Modifier and Type	Method	Description
FailJobCommandStep1.FailJobCommandStep2	errorMessage(String errorMsg)	Provide an error message describing the reason for the job failure.
FinalCommandStep<FailJobResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
FailJobCommandStep1.FailJobCommandStep2	retries(int retries)	Set the remaining retries of this job.
FailJobCommandStep1.FailJobCommandStep2	retryBackoff(Duration backoffTimeout)	Set the backoff timeout for failing this job.
ZeebeFuture<FailJobResponse>	send()	Sends the command to the Zeebe broker.
FailJobCommandStep1.FailJobCommandStep2	setVariablesInternal(String variables)
FailJobCommandStep1	useGrpc()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.
FailJobCommandStep1	useRest()	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

Methods inherited from class io.camunda.zeebe.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.zeebe.client.api.command.FailJobCommandStep1.FailJobCommandStep2

variable, variables, variables, variables, variables

Constructor Details

FailJobCommandImpl

public FailJobCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 JsonMapper jsonMapper,
 long key,
 Duration requestTimeout,
 Predicate<CredentialsProvider.StatusCode> retryPredicate,
 HttpClient httpClient,
 boolean preferRestOverGrpc)

Method Details

retries

public FailJobCommandStep1.FailJobCommandStep2 retries(int retries)

Description copied from interface: FailJobCommandStep1

Set the remaining retries of this job.

If the 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:

retries in interface FailJobCommandStep1

Parameters:

retries - the remaining retries of this job (e.g. "jobEvent.getRetries() - 1")

Returns:

the builder for this command. Call

invalid reference

#send()

to complete the command and send it to the broker.

retryBackoff

public FailJobCommandStep1.FailJobCommandStep2 retryBackoff(Duration backoffTimeout)

Description copied from interface: FailJobCommandStep1.FailJobCommandStep2

Set the backoff timeout for failing this job.

If the backoff timeout is greater than zero and retries are greater than zero then this job will be picked up again after the given backoff timeout is expired.

Specified by:

retryBackoff in interface FailJobCommandStep1.FailJobCommandStep2

Parameters:

backoffTimeout - the backoff timeout of this job

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send * it to the broker.

errorMessage

public FailJobCommandStep1.FailJobCommandStep2 errorMessage(String errorMsg)

Description copied from interface: FailJobCommandStep1.FailJobCommandStep2

Provide an error message describing the reason for the job failure. If failing the job creates an incident, this error message will be used as incident message.

Specified by:

errorMessage in interface FailJobCommandStep1.FailJobCommandStep2

Parameters:

errorMsg - error message to be attached to the failed job

Returns:

the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.

setVariablesInternal

public FailJobCommandStep1.FailJobCommandStep2 setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<FailJobCommandStep1.FailJobCommandStep2>

requestTimeout

public FinalCommandStep<FailJobResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<FailJobResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<FailJobResponse> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<FailJobResponse>

Returns:

a future tracking state of success/failure of the command.

useRest

public FailJobCommandStep1 useRest()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets REST as the communication API for this command. If this command doesn't support communication over REST, it simply returns the command builder instance unchanged. The default communication API can be configured using ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useRest in interface CommandWithCommunicationApiStep<FailJobCommandStep1>

Returns:

the configured command

useGrpc

public FailJobCommandStep1 useGrpc()

Description copied from interface: CommandWithCommunicationApiStep

Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for a REST API in Zeebe, and already wants to use this API during its development. As support for REST is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.

Sets gRPC as the communication API for this command. If this command doesn't support communication over gRPC, it simply returns the command builder instance unchanged. The default communication API can be configured using ZeebeClientBuilder.preferRestOverGrpc(boolean).

Specified by:

useGrpc in interface CommandWithCommunicationApiStep<FailJobCommandStep1>

Returns:

the configured command