BackendArgs

data class BackendArgs(val balancingMode: Output<BackendBalancingMode>? = null, val capacityScaler: Output<Double>? = null, val description: Output<String>? = null, val failover: Output<Boolean>? = null, val group: Output<String>? = null, val maxConnections: Output<Int>? = null, val maxConnectionsPerEndpoint: Output<Int>? = null, val maxConnectionsPerInstance: Output<Int>? = null, val maxRate: Output<Int>? = null, val maxRatePerEndpoint: Output<Double>? = null, val maxRatePerInstance: Output<Double>? = null, val maxUtilization: Output<Double>? = null) : ConvertibleToJava<BackendArgs>

Message containing information of one individual backend.

Constructors

Link copied to clipboard
fun BackendArgs(balancingMode: Output<BackendBalancingMode>? = null, capacityScaler: Output<Double>? = null, description: Output<String>? = null, failover: Output<Boolean>? = null, group: Output<String>? = null, maxConnections: Output<Int>? = null, maxConnectionsPerEndpoint: Output<Int>? = null, maxConnectionsPerInstance: Output<Int>? = null, maxRate: Output<Int>? = null, maxRatePerEndpoint: Output<Double>? = null, maxRatePerInstance: Output<Double>? = null, maxUtilization: Output<Double>? = null)

Functions

Link copied to clipboard
open override fun toJava(): BackendArgs

Properties

Link copied to clipboard
val balancingMode: Output<BackendBalancingMode>? = null

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. 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.

Link copied to clipboard
val capacityScaler: Output<Double>? = null

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 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.

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val failover: Output<Boolean>? = null

This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.

Link copied to clipboard
val group: Output<String>? = null

The 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. You must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.

Link copied to clipboard
val maxConnections: Output<Int>? = null

Defines 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.

Link copied to clipboard
val maxConnectionsPerEndpoint: Output<Int>? = null

Defines 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.

Link copied to clipboard
val maxConnectionsPerInstance: Output<Int>? = null

Defines 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.

Link copied to clipboard
val maxRate: Output<Int>? = null

Defines 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.

Link copied to clipboard
val maxRatePerEndpoint: Output<Double>? = null

Defines 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.

Link copied to clipboard
val maxRatePerInstance: Output<Double>? = null

Defines 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.

Link copied to clipboard
val maxUtilization: Output<Double>? = null

Optional 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.