Struct HealthCheckPolicy

#[non_exhaustive]
pub struct HealthCheckPolicy {
    pub timeout_millis: i64,
    pub interval_millis: i64,
    pub protocol: PortProtocol,
    pub port: Option<i32>,
    pub path: Option<String>,
    pub healthy_threshold: i32,
    pub unhealthy_threshold: i32,
}

An object that represents the health check policy for a virtual node's listener.

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.

timeout_millis: i64

The amount of time to wait when receiving a response from the health check, in milliseconds.

interval_millis: i64

The time period in milliseconds between each health check execution.

protocol: PortProtocol

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

port: Option<i32>

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

path: Option<String>

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

healthy_threshold: i32

The number of consecutive successful health checks that must occur before declaring listener healthy.

unhealthy_threshold: i32

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

Implementations

impl HealthCheckPolicy

pub fn timeout_millis(&self) -> i64

The amount of time to wait when receiving a response from the health check, in milliseconds.

pub fn interval_millis(&self) -> i64

The time period in milliseconds between each health check execution.

pub fn protocol(&self) -> &PortProtocol

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

pub fn port(&self) -> Option<i32>

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

pub fn path(&self) -> Option<&str>

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

pub fn healthy_threshold(&self) -> i32

The number of consecutive successful health checks that must occur before declaring listener healthy.

pub fn unhealthy_threshold(&self) -> i32

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

impl HealthCheckPolicy

pub fn builder() -> HealthCheckPolicyBuilder

Creates a new builder-style object to manufacture HealthCheckPolicy.

Trait Implementations

impl Clone for HealthCheckPolicy

fn clone(&self) -> HealthCheckPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckPolicy

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

Formats the value using the given formatter.

impl PartialEq for HealthCheckPolicy

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