ThrowErrorCommandStep1.ThrowErrorCommandStep2 (Zeebe Client Java 8.1.0-alpha2 API)

All Superinterfaces:: FinalCommandStep<Void>

All Known Implementing Classes:: ThrowErrorCommandImpl

Enclosing interface:: ThrowErrorCommandStep1

public static interface ThrowErrorCommandStep1.ThrowErrorCommandStep2 extends FinalCommandStep<Void>

Method Summary

Modifier and Type

Method

Description

ThrowErrorCommandStep1.ThrowErrorCommandStep2

errorMessage(String errorMsg)

Provide an error message describing the reason for the non-technical error.

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

Method Details
- errorMessage
  
  ThrowErrorCommandStep1.ThrowErrorCommandStep2 errorMessage(String errorMsg)
  
  Provide an error message describing the reason for the non-technical error. If the error is not caught by an error catch event, this message will be a part of the raised incident.
  
  Parameters:
  
  errorMsg - error message
  
  Returns:
  
  the builder for this command. Call FinalCommandStep.send() to complete the command and send it to the broker.