Struct ThrowErrorRequest 

pub struct ThrowErrorRequest<T: ThrowErrorRequestState> { /* private fields */ }

Request to throw a business error for a job

The error will be caught by an error catch event in the process. If no matching catch event exists, an incident will be raised instead.

Examples

client
    .throw_error()
    .with_job_key(123456)
    .with_error_code(String::from("error_code"))
    .send()
    .await?;

Implementations

impl ThrowErrorRequest<Initial>

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

Sets the job key for which to throw the error

Arguments

• job_key - Unique job identifier from job activation

Returns

A ThrowErrorRequest in the WithKey state

impl ThrowErrorRequest<WithKey>

pub fn with_error_code(self, error_code: String) -> ThrowErrorRequest<WithCode>

Sets the error code that will match an error catch event

Arguments

• error_code - Code that will be matched with an error catch event in the process

Returns

A ThrowErrorRequest in the WithCode state

impl ThrowErrorRequest<WithCode>

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

Sets an optional message describing the error

Arguments

• error_message - Additional context about the error

Returns

The updated ThrowErrorRequest with the error message set

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

Sets variables that will be available in the error catch event scope

Arguments

• data - Variables as serializable type that will be converted to JSON JSON document that will instantiate the variables at the local scope of the error catch event that catches the thrown error; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { “a”: 1, “b”: 2 } will create two variables, named “a” and “b” respectively, with their associated values. [{ “a”: 1, “b”: 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.

Errors

Returns ClientError if serialization fails

Returns

A Result containing the updated ThrowErrorRequest with the variables set, or a ClientError

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

Sends the throw error request to the gateway

Errors

• NOT_FOUND: No job exists with given key
• FAILED_PRECONDITION: Job is not in activated state

Returns

A Result containing a ThrowErrorResponse or a ClientError

Trait Implementations

impl<T: Clone + ThrowErrorRequestState> Clone for ThrowErrorRequest<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ThrowErrorRequestState> Debug for ThrowErrorRequest<T>

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

Formats the value using the given formatter.