FailJobCommandStep1.FailJobCommandStep2 (Zeebe Client Java 1.3.3 API)

All Superinterfaces:: FinalCommandStep<FailJobResponse>

All Known Implementing Classes:: FailJobCommandImpl

Enclosing interface:: FailJobCommandStep1

public static interface FailJobCommandStep1.FailJobCommandStep2 extends FinalCommandStep<FailJobResponse>

Method Summary

Modifier and Type

Method

Description

FailJobCommandStep1.FailJobCommandStep2

errorMessage(String errorMsg)

Provide an error message describing the reason for the job failure.

Methods inherited from interface io.camunda.zeebe.client.api.command.FinalCommandStep
requestTimeout, send

Method Details
- errorMessage
  
  FailJobCommandStep1.FailJobCommandStep2 errorMessage(String errorMsg)
  
  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.
  
  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.