Skip to main content

PauseRunResponse

Struct PauseRunResponse 

Source
pub struct PauseRunResponse {
Show 28 fields pub capacity_wait_kind: Option<String>, pub completed_at: Option<DateTime<Utc>>, pub concurrency_key: Option<String>, pub concurrency_limits: Vec<ConcurrencyLimit>, pub cost_usd: f64, pub created_at: DateTime<Utc>, pub created_by: CreatedBy, pub duration_ms: i64, pub error: Option<String>, pub handler_version: Option<String>, pub id: Uuid, pub idempotency_key: Option<String>, pub labels: HashMap<String, String>, pub lease_recoveries: i32, pub max_cost_usd: Option<f64>, pub max_retries: i32, pub output: Option<Value>, pub paused_descendants: Vec<Uuid>, pub priority: Option<i32>, pub resume_status: Option<RunStatus>, pub retry_count: i32, pub scheduled_at: Option<DateTime<Utc>>, pub started_at: Option<DateTime<Utc>>, pub status: RunStatus, pub trigger: TriggerKind, pub updated_at: DateTime<Utc>, pub worker_tags: Vec<String>, pub workflow_name: String,
}
Expand description

Response of POST /api/v1/runs/:id/pause: the paused run, with the sub-workflow runs paused along with it.

JSON schema
{
 "description": "Response of `POST /api/v1/runs/:id/pause`: the paused run, with the\nsub-workflow runs paused along with it.",
 "allOf": [
   {
     "$ref": "#/components/schemas/RunResponse"
   },
   {
     "type": "object",
     "required": [
       "paused_descendants"
     ],
     "properties": {
       "paused_descendants": {
         "description": "Sub-workflow runs below it that this request paused, oldest first.",
         "type": "array",
         "items": {
           "type": "string",
           "format": "uuid"
         }
       }
     }
   }
 ]
}
```ignore
</details>

Fields§

§capacity_wait_kind: Option<String>

Provider kind the run is waiting capacity for, set only while the run is sleeping because every targeted Provider Account is rate limited. scheduled_at then holds when the run wakes.

§completed_at: Option<DateTime<Utc>>

When execution completed.

§concurrency_key: Option<String>

Exclusivity key held by this run until it reaches a terminal state, when one was supplied.

§concurrency_limits: Vec<ConcurrencyLimit>

Concurrency groups the run belongs to, with the limit it was created with. Omitted when the run belongs to no group.

§cost_usd: f64

Aggregated cost in USD.

§created_at: DateTime<Utc>

When created.

§created_by: CreatedBy§duration_ms: i64

Total duration in milliseconds.

§error: Option<String>

Optional error message.

§handler_version: Option<String>

Version of the handler that created this run.

§id: Uuid

Unique run identifier.

§idempotency_key: Option<String>

Idempotency key that produced this run, when one was supplied.

§labels: HashMap<String, String>

User-defined key-value labels.

§lease_recoveries: i32

Number of times the run was requeued after its worker lost its lease. Separate from retry_count: it does not consume max_retries.

§max_cost_usd: Option<f64>

Cumulative cost cap for this run, in USD. None means no cap.

§max_retries: i32

Maximum allowed retries.

§output: Option<Value>

Typed output the handler set with WorkflowContext::set_output.

Written when the run ends (completed, warning, failed or cancelled). Omitted when the handler set no output.

§paused_descendants: Vec<Uuid>

Sub-workflow runs below it that this request paused, oldest first.

§priority: Option<i32>

Queue priority, from -100 to 100. Workers pick the pending run with the highest priority first, then the oldest among equal priorities. 0 is the default.

§resume_status: Option<RunStatus>§retry_count: i32

Number of times retried.

§scheduled_at: Option<DateTime<Utc>>

Scheduled execution time. None means the run executed immediately.

§started_at: Option<DateTime<Utc>>

When execution started.

§status: RunStatus§trigger: TriggerKind§updated_at: DateTime<Utc>

When last updated.

§worker_tags: Vec<String>

Tags a worker must carry to take this run, sorted. Empty when any worker can take it.

§workflow_name: String

Workflow name.

Implementations§

Trait Implementations§

Source§

impl Clone for PauseRunResponse

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PauseRunResponse

Source§

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

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

impl<'de> Deserialize<'de> for PauseRunResponse

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 From<PauseRunResponse> for PauseRunResponse

Source§

fn from(value: PauseRunResponse) -> Self

Converts to this type from the input type.
Source§

impl Serialize for PauseRunResponse

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

impl TryFrom<PauseRunResponse> for PauseRunResponse

Source§

type Error = ConversionError

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

fn try_from(value: PauseRunResponse) -> Result<Self, ConversionError>

Performs the conversion.

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 = !

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