Struct Probe 

pub struct Probe {
    pub handler: Option<ProbeHandler>,
    pub initial_delay_seconds: Option<i32>,
    pub timeout_seconds: Option<i32>,
    pub period_seconds: Option<i32>,
    pub success_threshold: Option<i32>,
    pub failure_threshold: Option<i32>,
    pub termination_grace_period_seconds: Option<i64>,
}

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Fields

handler: Option<ProbeHandler>

The action taken to determine the health of a container

initial_delay_seconds: Option<i32>

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional

timeout_seconds: Option<i32>

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional

period_seconds: Option<i32>

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. +optional

success_threshold: Option<i32>

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. +optional

failure_threshold: Option<i32>

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional

termination_grace_period_seconds: Option<i64>

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. +optional

Implementations

impl Probe

pub fn initial_delay_seconds(&self) -> i32

Returns the value of initial_delay_seconds, or the default value if initial_delay_seconds is unset.

pub fn timeout_seconds(&self) -> i32

Returns the value of timeout_seconds, or the default value if timeout_seconds is unset.

pub fn period_seconds(&self) -> i32

Returns the value of period_seconds, or the default value if period_seconds is unset.

pub fn success_threshold(&self) -> i32

Returns the value of success_threshold, or the default value if success_threshold is unset.

pub fn failure_threshold(&self) -> i32

Returns the value of failure_threshold, or the default value if failure_threshold is unset.

pub fn termination_grace_period_seconds(&self) -> i64

Returns the value of termination_grace_period_seconds, or the default value if termination_grace_period_seconds is unset.

Trait Implementations

impl Clone for Probe

fn clone(&self) -> Probe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Probe

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

Formats the value using the given formatter.

impl Default for Probe

fn default() -> Self

Returns the “default value” for a type.

impl Message for Probe

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 Probe

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