Struct TaskContainerDependency

#[non_exhaustive]
pub struct TaskContainerDependency {
    pub container_name: Option<String>,
    pub condition: Option<String>,
}

A list of containers that this task depends on.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

container_name: Option<String>

A unique identifier for the container.

condition: Option<String>

The dependency condition of the container. The following are the available conditions and their behavior:

• START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

• COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

Implementations

impl TaskContainerDependency

pub fn container_name(&self) -> Option<&str>

A unique identifier for the container.

pub fn condition(&self) -> Option<&str>

The dependency condition of the container. The following are the available conditions and their behavior:

• START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

• COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

• SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

impl TaskContainerDependency

pub fn builder() -> TaskContainerDependencyBuilder

Creates a new builder-style object to manufacture TaskContainerDependency.

Trait Implementations

impl Clone for TaskContainerDependency

fn clone(&self) -> TaskContainerDependency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskContainerDependency

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

Formats the value using the given formatter.

impl PartialEq for TaskContainerDependency

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