Skip to main content

Job

Struct Job 

Source
pub struct Job {
Show 15 fields pub command: Option<String>, pub created_at: DateTime<Utc>, pub depends_on: Vec<Uuid>, pub error_code: Option<String>, pub error_message: Option<String>, pub exit_code: Option<i64>, pub finished_at: Option<DateTime<Utc>>, pub id: Uuid, pub name: Option<String>, pub retry_policy: Option<Map<String, Value>>, pub soft_fail_policy: Option<Map<String, Value>>, pub soft_failed: bool, pub started_at: Option<DateTime<Utc>>, pub state: JobState, pub step_key: Option<String>,
}
Expand description

One job (DAG node) of a build.

JSON schema
{
 "title": "Job",
 "description": "One job (DAG node) of a build.",
 "type": "object",
 "required": [
   "created_at",
   "depends_on",
   "id",
   "soft_failed",
   "state"
 ],
 "properties": {
   "command": {
     "description": "The shell command the job runs.",
     "type": [
       "string",
       "null"
     ]
   },
   "created_at": {
     "description": "When the job row was created.",
     "type": "string",
     "format": "date-time"
   },
   "depends_on": {
     "description": "Ids of this job's prerequisite jobs (its DAG
in-edges), spanning both `depends_on` and `builds_in` dependency kinds.
Empty when the job has no prerequisites.",
     "type": "array",
     "items": {
       "type": "string",
       "format": "uuid"
     }
   },
   "error_code": {
     "description": "Stable job-level error code, if the job failed.",
     "type": [
       "string",
       "null"
     ]
   },
   "error_message": {
     "description": "Human-readable job-level error message, if any.",
     "type": [
       "string",
       "null"
     ]
   },
   "exit_code": {
     "description": "The command's exit status, once finished.",
     "type": [
       "integer",
       "null"
     ]
   },
   "finished_at": {
     "description": "When the job reached a terminal state.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "id": {
     "description": "The job's id.",
     "type": "string",
     "format": "uuid"
   },
   "name": {
     "description": "Human-readable job name.",
     "type": [
       "string",
       "null"
     ]
   },
   "retry_policy": {
     "description": "The job's retry policy, if any.",
     "type": [
       "object",
       "null"
     ],
     "additionalProperties": true
   },
   "soft_fail_policy": {
     "description": "The job's soft-fail policy, if any.",
     "type": [
       "object",
       "null"
     ],
     "additionalProperties": true
   },
   "soft_failed": {
     "description": "Whether the job failed but the build was allowed to
continue.",
     "type": "boolean"
   },
   "started_at": {
     "description": "When the job started running.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "state": {
     "description": "The job's FSM state.",
     "type": "string",
     "enum": [
       "pending",
       "scheduled",
       "assigned",
       "running",
       "passed",
       "failed",
       "skipped",
       "canceling",
       "canceled",
       "timing_out",
       "timed_out"
     ]
   },
   "step_key": {
     "description": "The job's stable key within the build's DAG.",
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields§

§command: Option<String>

The shell command the job runs.

§created_at: DateTime<Utc>

When the job row was created.

§depends_on: Vec<Uuid>

Ids of this job’s prerequisite jobs (its DAG in-edges), spanning both depends_on and builds_in dependency kinds. Empty when the job has no prerequisites.

§error_code: Option<String>

Stable job-level error code, if the job failed.

§error_message: Option<String>

Human-readable job-level error message, if any.

§exit_code: Option<i64>

The command’s exit status, once finished.

§finished_at: Option<DateTime<Utc>>

When the job reached a terminal state.

§id: Uuid

The job’s id.

§name: Option<String>

Human-readable job name.

§retry_policy: Option<Map<String, Value>>

The job’s retry policy, if any.

§soft_fail_policy: Option<Map<String, Value>>

The job’s soft-fail policy, if any.

§soft_failed: bool

Whether the job failed but the build was allowed to continue.

§started_at: Option<DateTime<Utc>>

When the job started running.

§state: JobState

The job’s FSM state.

§step_key: Option<String>

The job’s stable key within the build’s DAG.

Trait Implementations§

Source§

impl Clone for Job

Source§

fn clone(&self) -> Job

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 Job

Source§

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

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

impl<'de> Deserialize<'de> for Job

Source§

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

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

impl Serialize for Job

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Job

§

impl RefUnwindSafe for Job

§

impl Send for Job

§

impl Sync for Job

§

impl Unpin for Job

§

impl UnsafeUnpin for Job

§

impl UnwindSafe for Job

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