Struct WorkflowInputRequiredEvent 

pub struct WorkflowInputRequiredEvent {
    pub run_id: Uuid,
    pub step_id: Uuid,
    pub step_name: String,
    pub step_index: u32,
    pub message: String,
    pub schema: Value,
}

Payload of the WorkflowEvent::InputRequired workflow event.

Examples

use ironflow_engine::notify::WorkflowInputRequiredEvent;
use serde_json::json;
use uuid::Uuid;

let payload = WorkflowInputRequiredEvent {
    run_id: Uuid::now_v7(),
    step_id: Uuid::now_v7(),
    step_name: "clarify".to_string(),
    step_index: 2,
    message: "Answer the questions".to_string(),
    schema: json!({"type": "object"}),
};
assert_eq!(payload.step_name, "clarify");

Fields

run_id: Uuid

The run waiting for the input.

step_id: Uuid

Identifier of the human input step; the answer is posted to it.

step_name: String

Human-readable step name.

step_index: u32

Zero-based position in the workflow.

message: String

Message displayed to the person answering.

schema: Value

JSON schema the answer must match.

Trait Implementations

impl Clone for WorkflowInputRequiredEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowInputRequiredEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowInputRequiredEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkflowInputRequiredEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.