Zeebe C# Client 2.5.0
C# Client to communicate with an Zeebe Gateway
Loading...
Searching...
No Matches
Zeebe.Client.Api.Commands.IThrowErrorCommandStep2 Interface Reference
Inheritance diagram for Zeebe.Client.Api.Commands.IThrowErrorCommandStep2:
Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IThrowErrorResponse >

Public Member Functions

IThrowErrorCommandStep2 ErrorMessage (string errorMessage)
 Provide an error message describing the reason for the non-technical error. More...
 
IThrowErrorCommandStep2 Variables (string variables)
 Set the variables to send the error with. More...
 
- Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IThrowErrorResponse >
Task< T > SendWithRetry (TimeSpan? timeout=null, CancellationToken token=default)
 Sends the command with retry to the Zeebe broker. This operation is asynchronous. In case of success, the task returns the event that was generated by the Zeebe broker in response to the command. If the sending of the command fails, because of broker back pressure or network issues the request is retried until the command succeeds. The wait time between retries can be configured on the ZeebeClientBuilder. Per default the wait time is based on power two, which means 2^1 seconds, 2^2 seconds etc. until it reaches the maximum of one minute. More...
 

Member Function Documentation

◆ ErrorMessage()

IThrowErrorCommandStep2 Zeebe.Client.Api.Commands.IThrowErrorCommandStep2.ErrorMessage ( string  errorMessage)

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
errorMessagethe error message
Returns
The builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

◆ Variables()

IThrowErrorCommandStep2 Zeebe.Client.Api.Commands.IThrowErrorCommandStep2.Variables ( string  variables)

Set the variables to send the error with.

Parameters
variablesthe variables (JSON) as String.
Returns
the builder for this command. Call IFinalCommandWithRetryStep<T>.Send to complete the command and send it to the broker.

The documentation for this interface was generated from the following file: