Class Backend (1.39.0)
Backend(mapping=None,*,ignore_unknown_fields=False,**kwargs)Message containing information of one individual backend.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
|---|---|
| Name | Description |
balancing_mode | strSpecifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. Check the BalancingMode enum for the list of possible values. This field is a member of oneof__balancing_mode. |
capacity_scaler | floatA multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. This field is a member of oneof__capacity_scaler. |
custom_metrics | MutableSequence[google.cloud.compute_v1.types.BackendCustomMetric]List of custom metrics that are used for CUSTOM_METRICS BalancingMode. |
description | strAn optional description of this resource. Provide this property when you create the resource. This field is a member of oneof__description. |
failover | boolThis field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. This field is a member of oneof__failover. |
group | strThe fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the `Backend services overview |
max_connections | intDefines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. This field is a member of oneof__max_connections. |
max_connections_per_endpoint | intDefines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. This field is a member of oneof__max_connections_per_endpoint. |
max_connections_per_instance | intDefines a target maximum number of simultaneous connections. For usage guidelines, see Connection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is RATE. This field is a member of oneof__max_connections_per_instance. |
max_rate | intDefines a maximum number of HTTP requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. This field is a member of oneof__max_rate. |
max_rate_per_endpoint | floatDefines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. This field is a member of oneof__max_rate_per_endpoint. |
max_rate_per_instance | floatDefines a maximum target for requests per second (RPS). For usage guidelines, see Rate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode is CONNECTION. This field is a member of oneof__max_rate_per_instance. |
max_utilization | floatOptional parameter to define a target capacity for the UTILIZATION balancing mode. The valid range is [0.0, 1.0]. For usage guidelines, see Utilization balancing mode. This field is a member of oneof__max_utilization. |
preference | strThis field indicates whether this backend should be fully utilized before sending traffic to backends with default preference. The possible values are: - PREFERRED: Backends with this preference level will be filled up to their capacity limits first, based on RTT. - DEFAULT: If preferred backends don't have enough capacity, backends in this layer would be used and traffic would be assigned based on the load balancing algorithm you use. This is the default Check the Preference enum for the list of possible values. This field is a member of oneof__preference. |
Classes
BalancingMode
BalancingMode(value)Specifies how to determine whether the backend of a loadbalancer can handle additional traffic or is fully loaded. Forusage guidelines, see Connection balancing mode. Backends mustuse compatible balancing modes. For more information, seeSupported balancing modes and target capacity settings andRestrictions and guidance for instance groups. Note: Currently,if you use the API to configure incompatible balancing modes,the configuration might be accepted even though it has no impactand is ignored. Specifically, Backend.maxUtilization is ignoredwhen Backend.balancingMode is RATE. In the future, thisincompatible combination will be rejected.
Preference
Preference(value)This field indicates whether this backend should be fullyutilized before sending traffic to backends with defaultpreference. The possible values are: - PREFERRED: Backends withthis preference level will be filled up to their capacity limitsfirst, based on RTT. - DEFAULT: If preferred backends don't haveenough capacity, backends in this layer would be used andtraffic would be assigned based on the load balancing algorithmyou use. This is the default
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.