Struct ModifyProcessInstanceRequest 

pub struct ModifyProcessInstanceRequest<T: ModifyProcessInstanceState> { /* private fields */ }

Request to modify a process instance by activating/terminating elements

This struct represents a request to modify a process instance in the Zeebe workflow engine. It allows for building and sending instructions to activate specific elements or terminate specific element instances within a process instance.

The request goes through different states during its construction:

• Initial: The initial state where the process instance key is not yet set.
• WithProcessInstance: The state where the process instance key is set, and instructions can be added.

Example

client
    .modify_process_instance()
    .with_process_instance_key(12345)
        .with_activate_instruction("element_id".to_string(), 67890)
        .with_variable_instruction("scope_id".to_string(), serde_json::json!({"key": "value"}))?
        .build()
    .with_terminate_instruction(54321)
    .with_operation_reference(98765)
    .send()
    .await?;

Implementations

impl ModifyProcessInstanceRequest<Initial>

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

Sets the process instance key identifying which instance to modify

Arguments

• process_instance_key - The key of the process instance to modify

Returns

A ModifyProcessInstanceRequest<WithProcessInstance> with the process instance key set

impl ModifyProcessInstanceRequest<WithProcessInstance>

pub fn with_activate_instruction( self, element_id: String, ancestor_element_instance_key: i64, ) -> ActivateInstructionBuilder

Starts building an instruction to activate a specific element

Arguments

• element_id - ID of the element to activate
• ancestor_element_instance_key - Key of the ancestor scope

Returns

An ActivateInstructionBuilder instance to further build the instruction.

pub fn with_terminate_instruction(self, element_instance_key: i64) -> Self

Adds an instruction to terminate a specific element instance

Arguments

• element_instance_key - Key of the element instance to terminate

Returns

The modified ModifyProcessInstanceRequest instance.

pub fn with_terminate_instructions( self, element_instance_keys: Vec<i64>, ) -> Self

Adds instructions to terminate multiple element instances

Arguments

• element_instance_keys - Keys of element instances to terminate

Returns

The modified ModifyProcessInstanceRequest instance.

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

Sends the process instance modification request to the Zeebe workflow engine

Errors

• NOT_FOUND: No process instance exists with the given key
• INVALID_ARGUMENT: Invalid instructions or variables provided

Returns

A Result containing ModifyProcessInstanceResponse on success or ClientError on failure.

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

Returns

The modified ModifyProcessInstanceRequest instance.

Trait Implementations

impl<T: Clone + ModifyProcessInstanceState> Clone for ModifyProcessInstanceRequest<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ModifyProcessInstanceState> Debug for ModifyProcessInstanceRequest<T>

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

Formats the value using the given formatter.