Skip to main content

HealthCheckBuilder

bes_canopy_api::schema

Struct HealthCheckBuilder 

Source 
pub struct HealthCheckBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> HealthCheckBuilder<S>

Source

pub fn build(self) -> HealthCheck
where S: IsComplete,

Finish building and return the requested object

Source

pub fn check(self, value: String) -> HealthCheckBuilder<SetCheck<S>>
where S::Check: IsUnset,

Required.

Name of the check. Must be a non-empty string, and should stay stable across pushes: results for the same name are correlated over time, so successive failures and the eventual recovery land on the same issue.

Source

pub fn healthy(self, value: bool) -> HealthCheckBuilder<SetHealthy<S>>
where S::Healthy: IsUnset,

Optional (Some / Option setters). Legacy pass/fail form: true means passed, false means failed. Mutually exclusive with result.

Source

pub fn maybe_healthy( self, value: Option<bool>, ) -> HealthCheckBuilder<SetHealthy<S>>
where S::Healthy: IsUnset,

Optional (Some / Option setters). Legacy pass/fail form: true means passed, false means failed. Mutually exclusive with result.

Source

pub fn result(self, value: CheckResult) -> HealthCheckBuilder<SetResult<S>>
where S::Result: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_result( self, value: Option<CheckResult>, ) -> HealthCheckBuilder<SetResult<S>>
where S::Result: IsUnset,

Optional (Some / Option setters).

Source

pub fn extra(self, value: Map<String, Value>) -> HealthCheckBuilder<SetExtra<S>>
where S::Extra: IsUnset,

Optional (Some / Option setters). Default:

<::serde_json::Map<
    ::std::string::String,
    ::serde_json::Value,
> as Default>::default()

Any further keys the schema accepts alongside those above, carried verbatim.

Source

pub fn maybe_extra( self, value: Option<Map<String, Value>>, ) -> HealthCheckBuilder<SetExtra<S>>
where S::Extra: IsUnset,

Optional (Some / Option setters). Default:

<::serde_json::Map<
    ::std::string::String,
    ::serde_json::Value,
> as Default>::default()

Any further keys the schema accepts alongside those above, carried verbatim.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.