Enum SessionAffinity 

#[non_exhaustive]
pub enum SessionAffinity {
    ClientIp,
    ClientIpNoDestination,
    ClientIpPortProto,
    ClientIpProto,
    GeneratedCookie,
    HeaderField,
    HttpCookie,
    None,
    StrongCookieAffinity,
    UnknownValue(UnknownValue),
}

Available on crate feature target-pools only.

The enumerated type for the sessionAffinity 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.

ClientIp

2-tuple hash on packet’s source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.

ClientIpNoDestination

1-tuple hash only on packet’s source IP address. Connections from the same source IP address will be served by the same backend VM while that VM remains healthy. This option can only be used for Internal TCP/UDP Load Balancing.

ClientIpPortProto

5-tuple hash on packet’s source and destination IP addresses, IP protocol, and source and destination ports. Connections for the same IP protocol from the same source IP address and port to the same destination IP address and port will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

ClientIpProto

3-tuple hash on packet’s source and destination IP addresses, and IP protocol. Connections for the same IP protocol from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy. This option cannot be used for HTTP(S) load balancing.

GeneratedCookie

Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.

HeaderField

The hash is based on a user specified header field.

HttpCookie

The hash is based on a user provided cookie.

None

No session affinity. Connections from the same client IP may go to any instance in the pool.

StrongCookieAffinity

Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired.

UnknownValue(UnknownValue)

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

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

Implementations

impl SessionAffinity

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 SessionAffinity

fn clone(&self) -> SessionAffinity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionAffinity

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

Formats the value using the given formatter.

impl Default for SessionAffinity

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionAffinity

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SessionAffinity

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

Formats the value using the given formatter.

impl From<&str> for SessionAffinity

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for SessionAffinity

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for SessionAffinity

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

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 SessionAffinity