Struct CancelProcessInstanceRequest 

pub struct CancelProcessInstanceRequest<T: CancelProcessInstanceState> { /* private fields */ }

Request to cancel a running process instance

Examples

client
    .cancel_process_instance()
    .with_process_instance_key(123456)
    .send()
    .await?;

Errors:

• NOT_FOUND: no process instance exists with the given key

Implementations

impl CancelProcessInstanceRequest<Initial>

pub fn with_process_instance_key( self, process_instance_key: i64, ) -> CancelProcessInstanceRequest<WithProcessInstance>

Sets the process instance key identifying which instance to cancel

Arguments

• process_instance_key - The unique key identifying the process instance to cancel

Returns

A new CancelProcessInstanceRequest in the WithProcessInstance state

impl CancelProcessInstanceRequest<WithProcessInstance>

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

Sends the process instance cancellation request to the Zeebe workflow engine

Returns

A Result containing the CancelProcessInstanceResponse if successful, or a ClientError if not

pub fn with_operation_reference(self, operation_reference: u64) -> Self

Sets a reference key for tracking this operation

Arguments

• operation_reference - The reference key for tracking the operation

Returns

The updated CancelProcessInstanceRequest with the operation reference set

Trait Implementations

impl<T: Clone + CancelProcessInstanceState> Clone for CancelProcessInstanceRequest<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CancelProcessInstanceState> Debug for CancelProcessInstanceRequest<T>

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

Formats the value using the given formatter.