Enum DetailedHealthState 

#[non_exhaustive]
pub enum DetailedHealthState {
    Draining,
    Healthy,
    Timeout,
    Unhealthy,
    Unknown,
    UnknownValue(UnknownValue),
}

Available on crate features instance-group-managers or region-instance-group-managers only.

The enumerated type for the detailedHealthState field.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Draining

The instance is being drained. The existing connections to the instance have time to complete, but the new ones are being refused.

Healthy

The instance is reachable i.e. a connection to the application health checking endpoint can be established, and conforms to the requirements defined by the health check.

Timeout

The instance is unreachable i.e. a connection to the application health checking endpoint cannot be established, or the server does not respond within the specified timeout.

Unhealthy

The instance is reachable, but does not conform to the requirements defined by the health check.

Unknown

The health checking system is aware of the instance but its health is not known at the moment.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using DetailedHealthState::value or DetailedHealthState::name.

Implementations

impl DetailedHealthState

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

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

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

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for DetailedHealthState

fn clone(&self) -> DetailedHealthState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetailedHealthState

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

Formats the value using the given formatter.

impl Default for DetailedHealthState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DetailedHealthState

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DetailedHealthState

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

Formats the value using the given formatter.

impl From<&str> for DetailedHealthState

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for DetailedHealthState

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for DetailedHealthState

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DetailedHealthState