Struct docker_api::models::HealthConfig

pub struct HealthConfig {
    pub interval: Option<i64>,
    pub retries: Option<isize>,
    pub start_period: Option<i64>,
    pub test: Option<Vec<String, Global>>,
    pub timeout: Option<i64>,
}

A test to perform to check that the container is healthy.

Fields

interval: Option<i64>

The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

retries: Option<isize>

The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.

start_period: Option<i64>

Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

test: Option<Vec<String, Global>>

The test to perform. Possible values are:

• [] inherit healthcheck from image or parent image
• ["NONE"] disable healthcheck
• ["CMD", args...] exec arguments directly
• ["CMD-SHELL", command] run command with system’s default shell

timeout: Option<i64>

The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

Trait Implementations

impl Clone for HealthConfig

fn clone(&self) -> HealthConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HealthConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthConfig

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<HealthConfig> for HealthConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for HealthConfig

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 StructuralPartialEq for HealthConfig