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

Public Member Functions

IFailJobCommandStep2 ErrorMessage (string errorMsg)
 Set the error message of this failing job.
 
IFailJobCommandStep2 RetryBackOff (TimeSpan retryBackOff)
 Set the backoff timeout for the next retry of this job.
 
IFailJobCommandStep2 Variables (string variables)
 Set the variables to fail the job with.
 
- Public Member Functions inherited from Zeebe.Client.Api.Commands.IFinalCommandWithRetryStep< IFailJobResponse >
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.
 

Member Function Documentation

◆ ErrorMessage()

IFailJobCommandStep2 Zeebe.Client.Api.Commands.IFailJobCommandStep2.ErrorMessage ( string  errorMsg)

Set the error message of this failing job.

If the retries are zero then this error message will be used for the incident creation.

Parameters
errorMsgthe error msg for this failing job
Returns
the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

◆ RetryBackOff()

IFailJobCommandStep2 Zeebe.Client.Api.Commands.IFailJobCommandStep2.RetryBackOff ( TimeSpan  retryBackOff)

Set the backoff timeout for the next retry of this job.

Parameters
retryBackOffthe backoff timeout for the next retry of this job.
Returns
the builder for this command. Call IFinalCommandStep<T>.Send to complete the command and send it to the broker.

◆ Variables()

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

Set the variables to fail the job with.

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

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