Enum google_api_proto::google::cloud::compute::v1::backend_service::LocalityLbPolicy

#[repr(i32)]
pub enum LocalityLbPolicy {
    UndefinedLocalityLbPolicy = 0,
    InvalidLbPolicy = 323_318_707,
    LeastRequest = 46_604_921,
    Maglev = 119_180_266,
    OriginalDestination = 166_297_216,
    Random = 262_527_171,
    RingHash = 432_795_069,
    RoundRobin = 153_895_801,
    WeightedMaglev = 254_930_962,
}

The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Variants

UndefinedLocalityLbPolicy = 0

A value indicating that the enum field is not set.

InvalidLbPolicy = 323_318_707

LeastRequest = 46_604_921

An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests.

Maglev = 119_180_266

This algorithm implements consistent hashing to backends. Maglev can be used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824

OriginalDestination = 166_297_216

Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer.

Random = 262_527_171

The load balancer selects a random healthy host.

RingHash = 432_795_069

The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.

RoundRobin = 153_895_801

This is a simple policy in which each healthy backend is selected in round robin order. This is the default.

WeightedMaglev = 254_930_962

Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.

Implementations

impl LocalityLbPolicy

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of LocalityLbPolicy.

pub fn from_i32(value: i32) -> Option<LocalityLbPolicy>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a LocalityLbPolicy, or None if value is not a valid variant.

impl LocalityLbPolicy

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for LocalityLbPolicy

fn clone(&self) -> LocalityLbPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalityLbPolicy

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

Formats the value using the given formatter.

impl Default for LocalityLbPolicy

fn default() -> LocalityLbPolicy

Returns the “default value” for a type.

impl From<LocalityLbPolicy> for i32

fn from(value: LocalityLbPolicy) -> i32

Converts to this type from the input type.

impl Hash for LocalityLbPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LocalityLbPolicy

fn cmp(&self, other: &LocalityLbPolicy) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LocalityLbPolicy

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LocalityLbPolicy

fn partial_cmp(&self, other: &LocalityLbPolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for LocalityLbPolicy

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<LocalityLbPolicy, DecodeError>

Performs the conversion.

impl Copy for LocalityLbPolicy

impl Eq for LocalityLbPolicy

impl StructuralPartialEq for LocalityLbPolicy