Struct TaskSpec

pub struct TaskSpec {
    pub runnables: Vec<Runnable>,
    pub compute_resource: Option<ComputeResource>,
    pub max_run_duration: Option<Duration>,
    pub max_retry_count: i32,
    pub lifecycle_policies: Vec<LifecyclePolicy>,
    pub environments: HashMap<String, String>,
    pub volumes: Vec<Volume>,
    pub environment: Option<Environment>,
}

Spec of a task

Fields

runnables: Vec<Runnable>

The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag.

Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.

compute_resource: Option<ComputeResource>

ComputeResource requirements.

max_run_duration: Option<Duration>

Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.

max_retry_count: i32

Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].

lifecycle_policies: Vec<LifecyclePolicy>

Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.

environments: HashMap<String, String>

Deprecated: please use environment(non-plural) instead.

volumes: Vec<Volume>

Volumes to mount before running Tasks using this TaskSpec.

environment: Option<Environment>

Environment variables to set before running the Task.

Trait Implementations

impl Clone for TaskSpec

fn clone(&self) -> TaskSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskSpec

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

Formats the value using the given formatter.

impl Default for TaskSpec

fn default() -> Self

Returns the “default value” for a type.

impl Message for TaskSpec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TaskSpec

fn eq(&self, other: &TaskSpec) -> 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 StructuralPartialEq for TaskSpec