Class BackendServiceLocalityLoadBalancingPolicyConfigPolicy (0.11.0)

BackendServiceLocalityLoadBalancingPolicyConfigPolicy(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

The configuration for a built-in load balancing policy.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attribute

Name Description
name str
The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy. Do not specify the same policy more than once for a backend. If you do, the configuration is rejected. Check the Name enum for the list of possible values. This field is a member of oneof_ _name.

Classes

Name

Name(value)

The name of a locality load-balancing policy. Valid values include ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about these values, see the description of localityLbPolicy.

Do not specify the same policy more than once for a backend. If you do, the configuration is rejected.

    A Fast and Reliable Software Network Load
    Balancer.
ORIGINAL_DESTINATION (166297216):
    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 (262527171):
    The load balancer selects a random healthy
    host.
RING_HASH (432795069):
    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.
ROUND_ROBIN (153895801):
    This is a simple policy in which each healthy
    backend is selected in round robin order. This
    is the default.
WEIGHTED_GCP_RENDEZVOUS (82501640):
    Per-instance weighted Load Balancing via
    health check reported weights. In internal
    passthrough network load balancing, it is
    weighted rendezvous hashing.
    This option is only supported in internal
    passthrough network load balancing.
WEIGHTED_MAGLEV (254930962):
    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.
WEIGHTED_ROUND_ROBIN (5584977):
    Per-endpoint weighted round-robin Load
    Balancing using weights computed from Backend
    reported Custom Metrics. If set, the Backend
    Service responses are expected to contain
    non-standard HTTP response header field
    Endpoint-Load-Metrics. The reported metrics
    to use for computing the weights are specified
    via the customMetrics fields.