ComputeRegionBackendServiceRegionBackendServiceBackend class

One entry in the backends set. The backend's group is the self-link of an Instance Group, regional MIG, or regional Network Endpoint Group — all backends in a single service must share the same kind (no mixing IG with NEG). Note: regional backends carry a failover flag (used by ComputeRegionBackendServiceRegionBackendServiceFailoverPolicy) and do not support the global resource's preference field.

Annotations
  • @immutable

Constructors

ComputeRegionBackendServiceRegionBackendServiceBackend({required TfArg<String> group, RegionBackendServiceBalancingMode? balancingMode, TfArg<double>? capacityScaler, TfArg<String>? description, TfArg<bool>? failover, TfArg<int>? maxConnections, TfArg<int>? maxConnectionsPerEndpoint, TfArg<int>? maxConnectionsPerInstance, TfArg<int>? maxRate, TfArg<double>? maxRatePerEndpoint, TfArg<double>? maxRatePerInstance, TfArg<double>? maxUtilization, List<ComputeRegionBackendServiceRegionBackendServiceBackendCustomMetric>? customMetrics})
const

Properties

balancingMode → RegionBackendServiceBalancingMode?
How the load balancer measures capacity for this backend.
final
capacityScaler → TfArg<double>?
Multiplier on the group's configured capacity (0.0-1.0). Setting to 0.0 drains the backend. Cannot be set for INTERNAL (Passthrough NLB) backend services; required for every other scheme.
final
customMetrics → List<ComputeRegionBackendServiceRegionBackendServiceBackendCustomMetric>?
Custom metrics descriptors for CUSTOM_METRICS balancing.
final
description → TfArg<String>?
Free-form description.
final
failover → TfArg<bool>?
Marks this backend as a failover backend within an Internal Passthrough NLB. More than one failover backend may be configured; promotion is driven by ComputeRegionBackendServiceRegionBackendServiceFailoverPolicy.
final
group → TfArg<String>
Fully-qualified self-link of an Instance Group or Network Endpoint Group. Required.
final
hashCode → int
The hash code for this object.
no setterinherited
maxConnections → TfArg<int>?
Max simultaneous connections for the group (CONNECTION / UTILIZATION modes). Cannot be set for INTERNAL schemes.
final
maxConnectionsPerEndpoint → TfArg<int>?
Max simultaneous connections per endpoint (NEG-shaped backends).
final
maxConnectionsPerInstance → TfArg<int>?
Max simultaneous connections per backend instance (IG-shaped backends).
final
maxRate → TfArg<int>?
Max RPS for the group (RATE / UTILIZATION modes).
final
maxRatePerEndpoint → TfArg<double>?
Max RPS per endpoint.
final
maxRatePerInstance → TfArg<double>?
Max RPS per instance.
final
maxUtilization → TfArg<double>?
Target CPU utilization in UTILIZATION mode (0.0-1.0).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toArgMap() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited