Struct WorkflowHandle 

pub struct WorkflowHandle {
    pub workflow_id: String,
    pub run_id: Option<String>,
    pub workflow_type: String,
    /* private fields */
}

Fields

workflow_id: String

run_id: Option<String>

workflow_type: String

Implementations

impl WorkflowHandle

pub async fn describe(&self) -> Result<WorkflowDescription>

Describe whichever run is current for this stable workflow instance.

pub async fn describe_selected_run(&self) -> Result<WorkflowDescription>

Describe the run identity originally selected by this handle.

pub async fn signal<T: Serialize>( &self, signal_name: &str, input: T, ) -> Result<Value>

pub async fn signal_selected_run<T: Serialize>( &self, signal_name: &str, input: T, ) -> Result<Value>

Signal only if this handle’s selected run is still current.

pub async fn cancel( &self, options: WorkflowCommandOptions, ) -> Result<WorkflowCommandResult>

Request cooperative cancellation of whichever run is current.

pub async fn cancel_selected_run( &self, options: WorkflowCommandOptions, ) -> Result<WorkflowCommandResult>

Request cancellation only if this handle’s selected run is still current.

pub async fn terminate( &self, options: WorkflowCommandOptions, ) -> Result<WorkflowCommandResult>

Forcefully terminate whichever run is current.

pub async fn terminate_selected_run( &self, options: WorkflowCommandOptions, ) -> Result<WorkflowCommandResult>

Terminate only if this handle’s selected run is still current.

pub async fn query<T: Serialize>( &self, query_name: &str, input: T, ) -> Result<Value>

Execute a named, read-only query against this workflow.

pub async fn query_avro_value<T: Serialize>( &self, query_name: &str, input: T, ) -> Result<AvroValue>

pub async fn update<T: Serialize>( &self, update_name: &str, input: T, request_id: Option<&str>, ) -> Result<Value>

pub async fn update_avro_value<T: Serialize>( &self, update_name: &str, input: T, request_id: Option<&str>, ) -> Result<AvroValue>

pub async fn query_selected_run<T: Serialize>( &self, query_name: &str, input: T, ) -> Result<Value>

Query only if this handle’s selected run is still current.

pub async fn result(&self, options: WorkflowResultOptions) -> Result<Value>

Await the final terminal outcome of the current continue-as-new chain.

pub async fn result_avro_value( &self, options: WorkflowResultOptions, ) -> Result<AvroValue>

Await the final result without projecting Avro bytes through JSON.

pub async fn result_selected_run( &self, options: WorkflowResultOptions, ) -> Result<Value>

Await only the run identity originally selected by this handle.

pub async fn result_selected_run_avro_value( &self, options: WorkflowResultOptions, ) -> Result<AvroValue>

Await the selected run’s result on the lossless Avro Value surface.

Trait Implementations

impl Clone for WorkflowHandle

fn clone(&self) -> WorkflowHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowHandle

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

Formats the value using the given formatter.