Skip to main content

BatchOperation

Struct BatchOperation 

Source
pub struct BatchOperation {
Show 13 fields pub id: Option<String>, pub args: Vec<String>, pub description: Option<String>, pub headers: HashMap<String, String>, pub use_cache: Option<bool>, pub retry: Option<u32>, pub retry_delay: Option<String>, pub retry_max_delay: Option<String>, pub force_retry: bool, pub capture: Option<HashMap<String, String>>, pub capture_append: Option<HashMap<String, String>>, pub depends_on: Option<Vec<String>>, pub body_file: Option<String>,
}
Expand description

A single batch operation definition

Fields§

§id: Option<String>

Unique identifier for this operation (optional for independent ops, required when using capture, capture_append, or depends_on)

§args: Vec<String>

The command arguments to execute (e.g., ["users", "get", "--user-id", "123"])

§description: Option<String>

Optional description for this operation

§headers: HashMap<String, String>

Custom headers for this specific operation

§use_cache: Option<bool>

Whether to use cache for this operation (overrides global cache setting)

§retry: Option<u32>

Maximum number of retry attempts for this operation (overrides global retry setting)

§retry_delay: Option<String>

Initial delay between retries (e.g., “500ms”, “1s”)

§retry_max_delay: Option<String>

Maximum delay cap between retries (e.g., “30s”, “1m”)

§force_retry: bool

Force retry on non-idempotent requests without an idempotency key

§capture: Option<HashMap<String, String>>

Capture scalar values from the response using JQ syntax. Maps variable name → JQ query (e.g., {"user_id": ".id"}). Captured values are available for {{variable}} interpolation in subsequent operations.

§capture_append: Option<HashMap<String, String>>

Append extracted values to a named list using JQ syntax. Maps list name → JQ query. The list interpolates as a JSON array literal. Enables fan-out/aggregate patterns where N operations feed into a terminal call.

§depends_on: Option<Vec<String>>

Explicit dependency on other operations by their id. This operation will not execute until all dependencies have completed. Dependencies can also be inferred from {{variable}} usage in args.

§body_file: Option<String>

Read the request body from this file path instead of embedding it in args. Equivalent to passing --body-file <path> in args, but avoids quoting issues with long or prose-heavy JSON payloads. Mutually exclusive with a --body or --body-file entry in args.

Trait Implementations§

Source§

impl Clone for BatchOperation

Source§

fn clone(&self) -> BatchOperation

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BatchOperation

Source§

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

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

impl Default for BatchOperation

Source§

fn default() -> BatchOperation

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BatchOperation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for BatchOperation

Source§

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

Serialize this value into the given Serde serializer. Read more

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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: 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: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,