Struct ReadinessCheck 

#[non_exhaustive]
pub struct ReadinessCheck {
    pub path: String,
    pub host: String,
    pub failure_threshold: u32,
    pub success_threshold: u32,
    pub check_interval: Option<Duration>,
    pub timeout: Option<Duration>,
    pub app_start_timeout: Option<Duration>,
    /* private fields */
}

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

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.

path: String

The request path.

host: String

Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”

failure_threshold: u32

Number of consecutive failed checks required before removing traffic.

success_threshold: u32

Number of consecutive successful checks required before receiving traffic.

check_interval: Option<Duration>

Interval between health checks.

timeout: Option<Duration>

Time before the check is considered failed.

app_start_timeout: Option<Duration>

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

Implementations

impl ReadinessCheck

pub fn new() -> Self

Creates a new default instance.

pub fn set_path<T: Into<String>>(self, v: T) -> Self

Sets the value of path.

Example

let x = ReadinessCheck::new().set_path("example");

pub fn set_host<T: Into<String>>(self, v: T) -> Self

Sets the value of host.

Example

let x = ReadinessCheck::new().set_host("example");

pub fn set_failure_threshold<T: Into<u32>>(self, v: T) -> Self

Sets the value of failure_threshold.

Example

let x = ReadinessCheck::new().set_failure_threshold(42_u32);

pub fn set_success_threshold<T: Into<u32>>(self, v: T) -> Self

Sets the value of success_threshold.

Example

let x = ReadinessCheck::new().set_success_threshold(42_u32);

pub fn set_check_interval<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of check_interval.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_check_interval(Duration::default()/* use setters */);

pub fn set_or_clear_check_interval<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of check_interval.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_or_clear_check_interval(Some(Duration::default()/* use setters */));
let x = ReadinessCheck::new().set_or_clear_check_interval(None::<Duration>);

pub fn set_timeout<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of timeout.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_timeout(Duration::default()/* use setters */);

pub fn set_or_clear_timeout<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of timeout.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_or_clear_timeout(Some(Duration::default()/* use setters */));
let x = ReadinessCheck::new().set_or_clear_timeout(None::<Duration>);

pub fn set_app_start_timeout<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of app_start_timeout.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_app_start_timeout(Duration::default()/* use setters */);

pub fn set_or_clear_app_start_timeout<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of app_start_timeout.

Example

use wkt::Duration;
let x = ReadinessCheck::new().set_or_clear_app_start_timeout(Some(Duration::default()/* use setters */));
let x = ReadinessCheck::new().set_or_clear_app_start_timeout(None::<Duration>);

Trait Implementations

impl Clone for ReadinessCheck

fn clone(&self) -> ReadinessCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadinessCheck

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

Formats the value using the given formatter.

impl Default for ReadinessCheck

fn default() -> ReadinessCheck

Returns the “default value” for a type.

impl Message for ReadinessCheck

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ReadinessCheck

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadinessCheck