Enum relay_config::ReadinessCondition

pub enum ReadinessCondition {
    Authenticated,
    Always,
}

Controls responses from the readiness health check endpoint based on authentication.

Independent of the the readiness condition, shutdown always switches Relay into unready state.

Variants

Authenticated

(default) Relay is ready when authenticated and connected to the upstream.

Before authentication has succeeded and during network outages, Relay responds as not ready. Relay reauthenticates based on the http.auth_interval parameter. During reauthentication, Relay remains ready until authentication fails.

Authentication is only required for Relays in managed mode. Other Relays will only check for network outages.

Always

Relay reports readiness regardless of the authentication and networking state.

Trait Implementations

impl Clone for ReadinessCondition

fn clone(&self) -> ReadinessCondition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReadinessCondition

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

Formats the value using the given formatter.

impl Default for ReadinessCondition

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReadinessCondition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReadinessCondition

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ReadinessCondition

impl Eq for ReadinessCondition

impl StructuralPartialEq for ReadinessCondition