BackendServiceBackend class
Constructors
-
BackendServiceBackend({Input<String?>? balancingMode, Input<double?>? capacityScaler, Input<List<BackendServiceBackendCustomMetric>?>? customMetrics, Input<String?>? description, required Input<String> group, Input<int?>? maxConnections, Input<int?>? maxConnectionsPerEndpoint, Input<int?>? maxConnectionsPerInstance, Input<int?>? maxInFlightRequests, Input<int?>? maxInFlightRequestsPerEndpoint, Input<int?>? maxInFlightRequestsPerInstance, Input<int?>? maxRate, Input<double?>? maxRatePerEndpoint, Input<double?>? maxRatePerInstance, Input<double?>? maxUtilization, Input<String?>? preference, Input<String?>? trafficDuration})
-
Creates a new BackendServiceBackend.
balancingMode Specifies the balancing mode for this backend.
capacityScaler A multiplier applied to the group's maximum servicing capacity
customMetrics The set of custom metrics that are used for <code>CUSTOM_METRICS</code> BalancingMode.
description An optional description of this resource.
group The fully-qualified URL of an Instance Group or Network Endpoint
maxConnections The max number of simultaneous connections for the group. Can
maxConnectionsPerEndpoint The max number of simultaneous connections that a single backend
maxConnectionsPerInstance The max number of simultaneous connections that a single
maxInFlightRequests (Optional, Beta)
maxInFlightRequestsPerEndpoint (Optional, Beta)
maxInFlightRequestsPerInstance (Optional, Beta)
maxRate The max requests per second (RPS) of the group.
maxRatePerEndpoint The max requests per second (RPS) that a single backend network
maxRatePerInstance The max requests per second (RPS) that a single backend
maxUtilization Used when balancingMode is UTILIZATION. This ratio defines the
preference This field indicates whether this backend should be fully utilized before sending traffic to backends
trafficDuration (Optional, Beta)
const
-
BackendServiceBackend.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
balancingMode
→ Input<String?>?
-
Specifies the balancing mode for this backend.
For global HTTP(S) or TCP/SSL load balancing, the default is
UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)),
CUSTOM_METRICS (for HTTP(s)) and CONNECTION (for TCP/SSL).
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION.
Possible values are: UTILIZATION, RATE, CONNECTION, CUSTOM_METRICS, IN_FLIGHT.
final
-
capacityScaler
→ Input<double?>?
-
A multiplier applied to the group's maximum servicing capacity
(based on UTILIZATION, RATE or CONNECTION).
Default value is 1, which means the group will serve 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. Valid range is
0.0,1.0.
final
-
customMetrics
→ Input<List<BackendServiceBackendCustomMetric>?>?
-
The set of custom metrics that are used for <code>CUSTOM_METRICS</code> BalancingMode.
Structure is documented below.
final
-
description
→ Input<String?>?
-
An optional description of this resource.
Provide this property when you create the resource.
final
-
group
→ Input<String>
-
The fully-qualified URL of an Instance Group or Network Endpoint
Group resource. In case of instance group this defines the list
of instances that serve traffic. Member virtual machine
instances from each instance group must live in the same zone as
the instance group itself. No two backends in a backend service
are allowed to use same Instance Group resource.
For Network Endpoint Groups this defines list of endpoints. All
endpoints of Network Endpoint Group must be hosted on instances
located in the same zone as the Network Endpoint Group.
Backend services cannot mix Instance Group and
Network Endpoint Group backends.
Note that you must specify an Instance Group or Network Endpoint
Group resource using the fully-qualified URL, rather than a
partial URL.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
maxConnections
→ Input<int?>?
-
The max number of simultaneous connections for the group. Can
be used with either CONNECTION or UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or one
of maxConnectionsPerInstance or maxConnectionsPerEndpoint,
as appropriate for group type, must be set.
final
-
maxConnectionsPerEndpoint
→ Input<int?>?
-
The max number of simultaneous connections that a single backend
network endpoint can handle. This is used to calculate the
capacity of the group. Can be used in either CONNECTION or
UTILIZATION balancing modes.
For CONNECTION mode, either
maxConnections or maxConnectionsPerEndpoint must be set.
final
-
maxConnectionsPerInstance
→ Input<int?>?
-
The max number of simultaneous connections that a single
backend instance can handle. This is used to calculate the
capacity of the group. Can be used in either CONNECTION or
UTILIZATION balancing modes.
For CONNECTION mode, either maxConnections or
maxConnectionsPerInstance must be set.
final
-
maxInFlightRequests
→ Input<int?>?
-
(Optional, Beta)
Defines a maximum number of in-flight requests for the whole NEG
or instance group. Not available if backend's balancingMode is RATE
or CONNECTION.
final
-
maxInFlightRequestsPerEndpoint
→ Input<int?>?
-
(Optional, Beta)
Defines a maximum number of in-flight requests for a single endpoint.
Not available if backend's balancingMode is RATE or CONNECTION.
final
-
maxInFlightRequestsPerInstance
→ Input<int?>?
-
(Optional, Beta)
Defines a maximum number of in-flight requests for a single VM.
Not available if backend's balancingMode is RATE or CONNECTION.
final
-
maxRate
→ Input<int?>?
-
The max requests per second (RPS) of the group.
Can be used with either RATE or UTILIZATION balancing modes,
but required if RATE mode. For RATE mode, either maxRate or one
of maxRatePerInstance or maxRatePerEndpoint, as appropriate for
group type, must be set.
final
-
maxRatePerEndpoint
→ Input<double?>?
-
The max requests per second (RPS) that a single backend network
endpoint can handle. This is used to calculate the capacity of
the group. Can be used in either balancing mode. For RATE mode,
either maxRate or maxRatePerEndpoint must be set.
final
-
maxRatePerInstance
→ Input<double?>?
-
The max requests per second (RPS) that a single backend
instance can handle. This is used to calculate the capacity of
the group. Can be used in either balancing mode. For RATE mode,
either maxRate or maxRatePerInstance must be set.
final
-
maxUtilization
→ Input<double?>?
-
Used when balancingMode is UTILIZATION. This ratio defines the
CPU utilization target for the group. Valid range is
0.0, 1.0.
final
-
preference
→ Input<String?>?
-
This field indicates whether this backend should be fully utilized before sending traffic to backends
with default preference. This field cannot be set when loadBalancingScheme is set to 'EXTERNAL'. The possible values are:
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
trafficDuration
→ Input<String?>?
-
(Optional, Beta)
This field specifies how long a connection should be kept alive for:
final
