Struct JobSummary 

pub struct JobSummary {

    pub id: u64,
    pub repository: String,
    pub run_id: u64,
    pub run_attempt: u32,
    pub workflow: Option<String>,
    pub name: String,
    pub branch: Option<String>,
    pub url: Option<String>,
    pub labels: Vec<String>,
    pub state: JobState,
    pub conclusion: Option<String>,
    pub runner: Option<JobRunner>,
    pub timeline: Timeline,
    pub metrics: JobMetrics,
    pub log: LogSummary,
}

A job without its steps: what lists and events carry.

Fields

id: u64

GitHub’s job ID, also its check run ID.

repository: String

owner/name on GitHub.

run_id: u64

The workflow run it belongs to.

run_attempt: u32

1 for the first attempt of the run, higher for re-runs.

workflow: Option<String>

The workflow’s name.

name: String

The job’s name in the workflow.

branch: Option<String>

The branch the run is for.

url: Option<String>

The job’s page on GitHub.

labels: Vec<String>

The workflow’s runs-on labels.

state: JobState

Where the job is.

conclusion: Option<String>

GitHub’s conclusion once completed: success, failure, cancelled, skipped, timed_out, ….

runner: Option<JobRunner>

The runner that ran it.

timeline: Timeline

When each phase started.

metrics: JobMetrics

CPU, memory and network use while it ran.

log: LogSummary

How much of its log is stored.

Implementations

impl JobSummary

pub fn is_failure(&self) -> bool

Whether it failed, as GET /v1/stats counts failures: it concluded failure or timed_out, or it lost its runner. A job another machine ran is not this daemon’s to count.

pub fn outcome(&self) -> Outcome

Its outcome: where it is while it can change, then how it ended. Its kind is OutcomeKind::Failed exactly when it failed.

pub fn waited(&self, now: u64) -> Option<u64>

Seconds it waited for a runner: until it started, or until now while it may still start. None for a job that ended without starting here.

pub fn ran(&self, now: u64) -> Option<u64>

Seconds it ran: until it finished, or until now while it may still finish. None before it started, and for a final job without a finish time, which no client claims ran for as long as it has been since.

pub fn phases(&self) -> Vec<Phase>

Its phases in order, each from when it began to when it ended, None while it goes on. A phase without an end goes on while the job can change; a final job’s ends when the job finished, or is left out when no time says how long it took. Cleaning up follows the finish of a job whose runner started here, until its cleanup.

pub fn title(&self) -> JobTitle<'_>

Its name as every client writes it: workflow / job.

Trait Implementations

impl Clone for JobSummary

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 JobSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JobSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for JobSummary

impl PartialEq for JobSummary

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for JobSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JobSummary