pub struct HealthEndpointConfig {
pub health_path: String,
pub readiness_path: String,
pub liveness_path: String,
}Expand description
Configuration for built-in health endpoints.
By default RustAPI exposes three endpoints when enabled:
/health- aggregated dependency health/ready- readiness probe for orchestrators/load balancers/live- lightweight liveness probe
Fields§
§health_path: StringPath for the aggregated health endpoint.
readiness_path: StringPath for the readiness endpoint.
liveness_path: StringPath for the liveness endpoint.
Implementations§
Source§impl HealthEndpointConfig
impl HealthEndpointConfig
Sourcepub fn health_path(self, path: impl Into<String>) -> Self
pub fn health_path(self, path: impl Into<String>) -> Self
Override the health endpoint path.
Sourcepub fn readiness_path(self, path: impl Into<String>) -> Self
pub fn readiness_path(self, path: impl Into<String>) -> Self
Override the readiness endpoint path.
Sourcepub fn liveness_path(self, path: impl Into<String>) -> Self
pub fn liveness_path(self, path: impl Into<String>) -> Self
Override the liveness endpoint path.
Trait Implementations§
Source§impl Clone for HealthEndpointConfig
impl Clone for HealthEndpointConfig
Source§fn clone(&self) -> HealthEndpointConfig
fn clone(&self) -> HealthEndpointConfig
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for HealthEndpointConfig
impl Debug for HealthEndpointConfig
Source§impl Default for HealthEndpointConfig
impl Default for HealthEndpointConfig
Source§impl PartialEq for HealthEndpointConfig
impl PartialEq for HealthEndpointConfig
impl Eq for HealthEndpointConfig
impl StructuralPartialEq for HealthEndpointConfig
Auto Trait Implementations§
impl Freeze for HealthEndpointConfig
impl RefUnwindSafe for HealthEndpointConfig
impl Send for HealthEndpointConfig
impl Sync for HealthEndpointConfig
impl Unpin for HealthEndpointConfig
impl UnsafeUnpin for HealthEndpointConfig
impl UnwindSafe for HealthEndpointConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more