Package io.zeebe.client.impl.command
Class FailJobCommandImpl
- java.lang.Object
-
- io.zeebe.client.impl.command.FailJobCommandImpl
-
- All Implemented Interfaces:
FailJobCommandStep1
,FailJobCommandStep1.FailJobCommandStep2
,FinalCommandStep<FailJobResponse>
public final class FailJobCommandImpl extends Object implements FailJobCommandStep1, FailJobCommandStep1.FailJobCommandStep2
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.zeebe.client.api.command.FailJobCommandStep1
FailJobCommandStep1.FailJobCommandStep2
-
-
Constructor Summary
Constructors Constructor Description FailJobCommandImpl(GatewayGrpc.GatewayStub asyncStub, long key, Duration requestTimeout, Predicate<Throwable> retryPredicate)
-
Method Summary
All Methods Instance Methods Concrete Methods 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.ZeebeFuture<FailJobResponse>
send()
Sends the command to the Zeebe broker.
-
-
-
Constructor Detail
-
FailJobCommandImpl
public FailJobCommandImpl(GatewayGrpc.GatewayStub asyncStub, long key, Duration requestTimeout, Predicate<Throwable> retryPredicate)
-
-
Method Detail
-
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 interfaceFailJobCommandStep1
- Parameters:
retries
- the remaining retries of this job (e.g. "jobEvent.getRetries() - 1")- Returns:
- the builder for this command. Call
#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 interfaceFailJobCommandStep1.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.
-
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 usingZeebeClientBuilder.defaultRequestTimeout(Duration)
.- Specified by:
requestTimeout
in interfaceFinalCommandStep<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<JobEvent> future = command.send(); JobEvent event = future.join();
- Specified by:
send
in interfaceFinalCommandStep<FailJobResponse>
- Returns:
- a future tracking state of success/failure of the command.
-
-