Skip to main content

RunCommands

Enum RunCommands 

Source
pub enum RunCommands {
Show 13 variants Create { workflow: String, payload: Option<String>, payload_file: Option<PathBuf>, max_retries: Option<u32>, idempotency_key: Option<String>, max_cost: Option<f64>, concurrency_key: Option<String>, }, List { status: Option<String>, workflow: Option<String>, created_by: Option<Uuid>, page: Option<u32>, per_page: Option<u32>, }, Get { id: Uuid, }, Cancel { id: Uuid, }, Approve { id: Uuid, }, Reject { id: Uuid, }, Input { id: Uuid, step_id: Uuid, value: Option<String>, value_file: Option<PathBuf>, }, RejectInput { id: Uuid, step_id: Uuid, reason: Option<String>, }, Retry { id: Uuid, force: bool, }, Replay { id: Uuid, }, Watch { id: Uuid, no_logs: bool, timeout: Option<Duration>, }, Plan { workflow: String, input: Option<String>, input_file: Option<PathBuf>, max_depth: Option<u32>, no_estimates: bool, }, Diff { run_a: Uuid, run_b: Uuid, },
}
Expand description

Available run subcommands.

Variants§

§

Create

Create a new run for a workflow.

Fields

§workflow: String

Workflow name to trigger.

§payload: Option<String>

JSON payload (inline string).

§payload_file: Option<PathBuf>

Path to a JSON file containing the payload.

§max_retries: Option<u32>

How many times to replay the run automatically after a transient failure. Defaults to 0 (no automatic retry).

§idempotency_key: Option<String>

Idempotency key making the call safe to replay.

Reusing the same key returns the run it already created instead of starting a second one. Valid for 24 hours. At most 255 printable ASCII characters.

§max_cost: Option<f64>

Maximum cumulative cost for this run, in USD. Overrides the workflow and server defaults.

§concurrency_key: Option<String>

Exclusivity key: the call is refused while a non-terminal run holds the same key. Released once that run completes, fails or is cancelled. At most 255 bytes.

§

List

List runs with optional filters.

Fields

§status: Option<String>

Filter by run status (pending, running, completed, failed, etc.).

§workflow: Option<String>

Filter by workflow name.

§created_by: Option<Uuid>

Filter by author: the user ID that triggered the run.

Also matches runs triggered by one of that user’s API keys.

§page: Option<u32>

Page number (1-based).

§per_page: Option<u32>

Items per page.

§

Get

Get details of a specific run.

Fields

§id: Uuid

Run UUID.

§

Cancel

Cancel a pending or running run.

Fields

§id: Uuid

Run UUID.

§

Approve

Approve a run waiting for approval.

Fields

§id: Uuid

Run UUID.

§

Reject

Reject a run waiting for approval, failing it.

Fields

§id: Uuid

Run UUID.

§

Input

Answer a human input step; the value must match the step’s JSON schema.

Fields

§id: Uuid

Run UUID.

§step_id: Uuid

Human input step UUID.

§value: Option<String>

JSON answer (inline string).

§value_file: Option<PathBuf>

Path to a JSON file containing the answer.

§

RejectInput

Reject a human input step; the handler receives the rejection.

Fields

§id: Uuid

Run UUID.

§step_id: Uuid

Human input step UUID.

§reason: Option<String>

Why the input is refused.

§

Retry

Retry a failed run.

Fields

§id: Uuid

Run UUID.

§force: bool

Force retry even when the handler version has changed since the original run.

§

Replay

Replay a finished run on the current handler version.

Fields

§id: Uuid

Run UUID.

§

Watch

Watch a run in real time via SSE.

Fields

§id: Uuid

Run UUID.

§no_logs: bool

Only show step transitions, not log data.

§timeout: Option<Duration>

Stop watching after this duration (e.g. “30s”, “5m”, “1h”).

§

Plan

Show the execution plan for a workflow without running it.

Fields

§workflow: String

Workflow name.

§input: Option<String>

JSON input (inline string).

§input_file: Option<PathBuf>

Path to a JSON file containing the input.

§max_depth: Option<u32>

How deep sub-workflows are expanded (default 3).

§no_estimates: bool

Skip duration estimation from run history.

§

Diff

Compare two runs of the same workflow side by side.

Fields

§run_a: Uuid

First run UUID.

§run_b: Uuid

Second run UUID.

Trait Implementations§

Source§

impl Debug for RunCommands

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for RunCommands

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for RunCommands

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more