Struct FailJobRequest 

pub struct FailJobRequest<T: FailJobRequestState> { /* private fields */ }

Request to mark a job as failed

This struct uses a builder pattern with state transitions to ensure that required fields are set before sending the request. The state transitions are enforced at compile time using marker traits.

Examples

client
    .fail_job()
    .with_job_key(123456)
    .send()
    .await?;

Implementations

impl FailJobRequest<Initial>

pub fn with_job_key(self, job_key: i64) -> FailJobRequest<WithKey>

Sets the job key to identify which job failed

Arguments

• job_key - The unique key identifying the job

Returns

A FailJobRequest in the WithKey state

Examples found in repository

examples/custom_auto_handler.rs (line 32)

    async fn handle_result(self, client: Client, job: ActivatedJob) {
        match *self {
            Ok(_) => unreachable!("This will always fail!"),
            Err(_) => {
                let _ = client.fail_job().with_job_key(job.key()).send().await;
            }
        }
    }

impl FailJobRequest<WithKey>

pub fn with_retries(self, retries: i32) -> Self

Sets the number of remaining retries for the job

Arguments

• retries - The number of remaining retries for the job

Returns

The updated FailJobRequest

pub fn with_error_message(self, error_message: String) -> Self

Sets an error message describing why the job failed

Arguments

• error_message - A message describing why the job failed

Returns

The updated FailJobRequest

pub fn with_retry_back_off(self, retry_back_off: Duration) -> Self

Sets the time to wait before retrying the job

Arguments

• retry_back_off - Time to wait in seconds before retrying

Returns

The updated FailJobRequest

pub fn with_variables<T: Serialize>(self, data: T) -> Result<Self, ClientError>

Sets variables to be included with the job failure

Arguments

• data - The variables to be included with the job failure

Returns

The updated FailJobRequest or a ClientError if serialization fails

pub async fn send(self) -> Result<FailJobResponse, ClientError>

Sends the job failure request to the Zeebe workflow engine

Returns

A Result containing a FailJobResponse if successful, or a ClientError if the request fails

Examples found in repository

examples/custom_auto_handler.rs (line 32)

    async fn handle_result(self, client: Client, job: ActivatedJob) {
        match *self {
            Ok(_) => unreachable!("This will always fail!"),
            Err(_) => {
                let _ = client.fail_job().with_job_key(job.key()).send().await;
            }
        }
    }

Trait Implementations

impl<T: Clone + FailJobRequestState> Clone for FailJobRequest<T>

fn clone(&self) -> FailJobRequest<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + FailJobRequestState> Debug for FailJobRequest<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.