Struct HealthConfigBuilder

pub struct HealthConfigBuilder { /* private fields */ }

Builder for HealthConfig.

Implementations

impl HealthConfigBuilder

pub fn test<VALUE: Into<Option<Vec<String>>>>( &mut self, value: VALUE, ) -> &mut Self

Test is the test to perform to check that the container is healthy. An empty slice means to inherit the default. The options are: {} : inherit healthcheck. {“NONE”} : disable healthcheck. {“CMD”, args…} : exec arguments directly. {“CMD-SHELL”, command} : run command with system’s default shell.

pub fn interval_nanoseconds<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Zero means to inherit. Durations are expressed as integer nanoseconds. interval_nanoseconds is the time to wait between checks.

pub fn timeout_nanoseconds<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

Timeout is the time to wait before considering the check to have hung.

pub fn start_period_nanoseconds<VALUE: Into<Option<i64>>>( &mut self, value: VALUE, ) -> &mut Self

The start period for the container to initialize before the retries starts to count down.

pub fn retries<VALUE: Into<Option<i32>>>(&mut self, value: VALUE) -> &mut Self

Retries is the number of consecutive failures needed to consider a container as unhealthy. Zero means inherit.

pub fn build(&self) -> Result<HealthConfig, String>

Builds a new HealthConfig.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for HealthConfigBuilder

fn clone(&self) -> HealthConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for HealthConfigBuilder

fn default() -> HealthConfigBuilder

Returns the “default value” for a type.