Struct Job

pub struct Job {

    pub cond: Option<Expression>,
    pub name: Option<String>,
    pub runs_on: Option<RunsOn>,
    pub permissions: Option<Permissions>,
    pub env: Option<Env>,
    pub strategy: Option<Strategy>,
    pub steps: Option<Vec<StepValue>>,
    pub uses: Option<String>,
    pub container: Option<Container>,
    pub outputs: Option<IndexMap<String, String>>,
    pub concurrency: Option<Concurrency>,
    pub timeout_minutes: Option<u32>,
    pub services: Option<IndexMap<String, Container>>,
    pub secrets: Option<IndexMap<String, Secret>>,
    pub defaults: Option<Defaults>,
    pub continue_on_error: Option<bool>,
    pub retry: Option<RetryStrategy>,
    pub artifacts: Option<Artifacts>,
    /* private fields */
}

Represents a job in the workflow.

Fields

cond: Option<Expression>

name: Option<String>

runs_on: Option<RunsOn>

permissions: Option<Permissions>

env: Option<Env>

strategy: Option<Strategy>

steps: Option<Vec<StepValue>>

uses: Option<String>

container: Option<Container>

outputs: Option<IndexMap<String, String>>

concurrency: Option<Concurrency>

timeout_minutes: Option<u32>

services: Option<IndexMap<String, Container>>

secrets: Option<IndexMap<String, Secret>>

defaults: Option<Defaults>

continue_on_error: Option<bool>

retry: Option<RetryStrategy>

artifacts: Option<Artifacts>

Implementations

impl Job

pub fn tmp_needs(self, value: impl Into<Vec<Job>>) -> Job

pub fn cond(self, value: impl Into<Expression>) -> Job

Sets the cond field of this struct.

pub fn name(self, value: impl Into<String>) -> Job

Sets the name field of this struct.

pub fn runs_on(self, value: impl Into<RunsOn>) -> Job

Sets the runs_on field of this struct.

pub fn permissions(self, value: impl Into<Permissions>) -> Job

Sets the permissions field of this struct.

pub fn env(self, value: impl Into<Env>) -> Job

Sets the env field of this struct.

pub fn strategy(self, value: impl Into<Strategy>) -> Job

Sets the strategy field of this struct.

pub fn steps(self, value: impl Into<Vec<StepValue>>) -> Job

Sets the steps field of this struct.

pub fn uses(self, value: impl Into<String>) -> Job

Sets the uses field of this struct.

pub fn container(self, value: impl Into<Container>) -> Job

Sets the container field of this struct.

pub fn outputs(self, value: impl Into<IndexMap<String, String>>) -> Job

Sets the outputs field of this struct.

pub fn concurrency(self, value: impl Into<Concurrency>) -> Job

Sets the concurrency field of this struct.

pub fn timeout_minutes(self, value: impl Into<u32>) -> Job

Sets the timeout_minutes field of this struct.

pub fn services(self, value: impl Into<IndexMap<String, Container>>) -> Job

Sets the services field of this struct.

pub fn secrets(self, value: impl Into<IndexMap<String, Secret>>) -> Job

Sets the secrets field of this struct.

pub fn defaults(self, value: impl Into<Defaults>) -> Job

Sets the defaults field of this struct.

pub fn continue_on_error(self, value: impl Into<bool>) -> Job

Sets the continue_on_error field of this struct.

pub fn retry(self, value: impl Into<RetryStrategy>) -> Job

Sets the retry field of this struct.

pub fn artifacts(self, value: impl Into<Artifacts>) -> Job

Sets the artifacts field of this struct.

impl Job

pub fn new<T>(name: T) -> Job

where T: ToString,

Creates a new Job with the specified name and default settings.

pub fn add_step_when<S, T>(self, cond: bool, step: S) -> Job

where S: Into<Step<T>>, T: StepType,

Adds a step to the job when a condition is met.

pub fn add_step<S, T>(self, step: S) -> Job

where S: Into<Step<T>>, T: StepType,

Adds a step to the job.

pub fn add_env<T>(self, new_env: T) -> Job

where T: Into<Env>,

Adds an environment variable to the job.

pub fn add_env_when<T>(self, cond: bool, new_env: T) -> Job

where T: Into<Env>,

Adds an environment variable to the job when a condition is met.

pub fn add_steps<T, I>(self, steps: I) -> Job

where T: StepType, I: IntoIterator<Item = Step<T>>,

Add multiple steps to the job at once.

This is a convenience method that takes a vector of steps and adds them all to the job in order.

pub fn add_needs<J>(self, needs: J) -> Job

where J: Into<Job>,

pub fn add_needs_when<T>(self, cond: bool, needs: T) -> Job

where T: Into<Job>,

Adds a dependency to the job when a condition is met.

Trait Implementations

impl Clone for Job

fn clone(&self) -> Job

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Job

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

Formats the value using the given formatter.

impl Default for Job

fn default() -> Job

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Job

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Job

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.

impl Eq for Job

impl StructuralPartialEq for Job