RegionBackendServiceBackend class
Constructors
-
RegionBackendServiceBackend({Input<String?>? balancingMode, Input<double?>? capacityScaler, Input<List<RegionBackendServiceBackendCustomMetric>?>? customMetrics, Input<String?>? description, Input<bool?>? failover, 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?>? trafficDuration})
-
Creates a new RegionBackendServiceBackend.
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.
failover This field designates whether this is a failover backend. More
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. Cannot be set
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
trafficDuration (Optional, Beta)
const
-
RegionBackendServiceBackend.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
balancingMode
→ Input<String?>?
-
Specifies the balancing mode for this backend.
See the Backend Services Overview
for an explanation of load balancing modes.
Default value is
UTILIZATION.
Possible values are: UTILIZATION, RATE, CONNECTION, CUSTOM_METRICS.
final
-
capacityScaler
→ Input<double?>?
-
A multiplier applied to the group's maximum servicing capacity
(based on UTILIZATION, RATE or CONNECTION).
~>NOTE: This field cannot be set for
INTERNAL region backend services (default loadBalancingScheme),
but is required for non-INTERNAL backend service. The total
capacityScaler for all backends must be non-zero.
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<RegionBackendServiceBackendCustomMetric>?>?
-
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
-
failover
→ Input<bool?>?
-
This field designates whether this is a failover backend. More
than one failover backend can be configured for a given RegionBackendService.
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.
When the
loadBalancingScheme is INTERNAL, only instance groups
are supported.
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.
Cannot be set for INTERNAL backend services.
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. Cannot be set
for INTERNAL backend services.
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. Cannot be set for INTERNAL backend
services.
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. Cannot be set
for INTERNAL backend services.
Can be used with either RATE or UTILIZATION balancing modes,
but required if 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. Cannot be set
for INTERNAL backend services.
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. Cannot be set
for INTERNAL backend services.
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.
Cannot be set for INTERNAL backend services.
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
