Struct HealthCheckBuilder

#[non_exhaustive]
pub struct HealthCheckBuilder { /* private fields */ }

A builder for HealthCheck.

Implementations

impl HealthCheckBuilder

pub fn target(self, input: impl Into<String>) -> Self

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

This field is required.

pub fn set_target(self, input: Option<String>) -> Self

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

pub fn get_target(&self) -> &Option<String>

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

pub fn interval(self, input: i32) -> Self

The approximate interval, in seconds, between health checks of an individual instance.

This field is required.

pub fn set_interval(self, input: Option<i32>) -> Self

The approximate interval, in seconds, between health checks of an individual instance.

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

The approximate interval, in seconds, between health checks of an individual instance.

pub fn timeout(self, input: i32) -> Self

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

This field is required.

pub fn set_timeout(self, input: Option<i32>) -> Self

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

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

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

pub fn unhealthy_threshold(self, input: i32) -> Self

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

This field is required.

pub fn set_unhealthy_threshold(self, input: Option<i32>) -> Self

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

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

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

pub fn healthy_threshold(self, input: i32) -> Self

The number of consecutive health checks successes required before moving the instance to the Healthy state.

This field is required.

pub fn set_healthy_threshold(self, input: Option<i32>) -> Self

The number of consecutive health checks successes required before moving the instance to the Healthy state.

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

The number of consecutive health checks successes required before moving the instance to the Healthy state.

pub fn build(self) -> Result<HealthCheck, BuildError>

Consumes the builder and constructs a HealthCheck. This method will fail if any of the following fields are not set:

• target
• interval
• timeout
• unhealthy_threshold
• healthy_threshold

Trait Implementations

impl Clone for HealthCheckBuilder

fn clone(&self) -> HealthCheckBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckBuilder

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

Formats the value using the given formatter.

impl Default for HealthCheckBuilder

fn default() -> HealthCheckBuilder

Returns the “default value” for a type.

impl PartialEq for HealthCheckBuilder

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

Tests for self and other values to be equal, and is used by ==.

const 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 HealthCheckBuilder