1.57.0 (latest) 1.56.0 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.29.0 1.28.0 1.27.0 1.26.0 1.25.0 1.24.0 1.23.0 1.22.0 1.21.0 1.20.1 1.19.2 1.18.0 1.17.0 1.16.1 1.15.0 1.14.1 1.13.0 1.12.1 1.11.0 1.10.1 1.9.0 1.8.0 1.7.0 1.6.1 1.5.2 1.4.0 1.3.2 1.2.0 1.1.0 1.0.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.2 0.3.0 0.2.1 0.1.0

```python
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` | `str` Specifies 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. Backends of a backend service may use different 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` | `float` A 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 onbalancingMode). 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 than0.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 abalancingMode. 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` | `str` An optional description of this resource. Provide this property when you create the resource. This field is a member of `oneof`_ `_description`. |
| `failover` | `bool` This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. This field can only be used for a regional external Passthrough Network Load Balancer or a regional internal Passthrough Network Load Balancer. This field is a member of `oneof`_ `_failover`. |
| `group` | `str` The fully-qualified URL of aninstance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the \`Backend services overview |
| `max_connections` | `int` Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend'sbalancingMode is RATE. This field is a member of `oneof`_ `_max_connections`. |
| `max_connections_per_endpoint` | `int` Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode isRATE. This field is a member of `oneof`_ `_max_connections_per_endpoint`. |
| `max_connections_per_instance` | `int` Defines a target maximum number of simultaneous connections. For usage guidelines, seeConnection balancing mode and Utilization balancing mode. Not available if the backend's balancingMode isRATE. This field is a member of `oneof`_ `_max_connections_per_instance`. |
| `max_in_flight_requests` | `int` Defines a maximum number of in-flight requests for the whole NEG or instance group. Not available if backend's balancingMode isRATE or CONNECTION. This field is a member of `oneof`_ `_max_in_flight_requests`. |
| `max_in_flight_requests_per_endpoint` | `int` Defines a maximum number of in-flight requests for a single endpoint. Not available if backend's balancingMode is RATE or CONNECTION. This field is a member of `oneof`_ `_max_in_flight_requests_per_endpoint`. |
| `max_in_flight_requests_per_instance` | `int` Defines a maximum number of in-flight requests for a single VM. Not available if backend's balancingMode is RATE or CONNECTION. This field is a member of `oneof`_ `_max_in_flight_requests_per_instance`. |
| `max_rate` | `int` Defines a maximum number of HTTP requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode isCONNECTION. This field is a member of `oneof`_ `_max_rate`. |
| `max_rate_per_endpoint` | `float` Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode isCONNECTION. This field is a member of `oneof`_ `_max_rate_per_endpoint`. |
| `max_rate_per_instance` | `float` Defines a maximum target for requests per second (RPS). For usage guidelines, seeRate balancing mode and Utilization balancing mode. Not available if the backend's balancingMode isCONNECTION. This field is a member of `oneof`_ `_max_rate_per_instance`. |
| `max_utilization` | `float` Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is\[0.0, 1.0\]. For usage guidelines, seeUtilization balancing mode. This field is a member of `oneof`_ `_max_utilization`. |
| `orchestration_info` | `google.cloud.compute_v1.types.BackendBackendOrchestrationInfo` Information about the resource or system that manages the backend. This field is a member of `oneof`_ `_orchestration_info`. |
| `preference` | `str` This 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 For global external Passthrough Network Load Balancers, the following restrictions apply: - At most one backend can be marked as PREFERRED. - PREFERRED and DEFAULT backends cannot reside in the same Cloud region. Check the Preference enum for the list of possible values. This field is a member of `oneof`_ `_preference`. |
| `traffic_duration` | `str` Check the TrafficDuration enum for the list of possible values. This field is a member of `oneof`_ `_traffic_duration`. |

## Classes

### BalancingMode

```python
BalancingMode(value)
```
Specifies 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. Backends of a
backend service may use different 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.

### Preference

```python
Preference(value)
```
This 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

For global external Passthrough Network Load Balancers, the
following restrictions apply:

- At most one backend can be marked as PREFERRED.
- PREFERRED and DEFAULT backends cannot reside in the same Cloud region.

### TrafficDuration

```python
TrafficDuration(value)
```