Reference documentation and code samples for the Compute V1 Client class WeightedBackendService.
In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService
Generated from protobuf messagegoogle.cloud.compute.v1.WeightedBackendService
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ backend_service
string
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.
Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
↳ weight
int
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.
getBackendService
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.
Returns
Type
Description
string
hasBackendService
clearBackendService
setBackendService
The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getHeaderAction
Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.
Returns
Type
Description
int
hasWeight
clearWeight
setWeight
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class WeightedBackendService (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.WeightedBackendService)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.WeightedBackendService)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.WeightedBackendService)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.WeightedBackendService)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.WeightedBackendService)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.WeightedBackendService)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.WeightedBackendService)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.WeightedBackendService)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.WeightedBackendService)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.WeightedBackendService)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.WeightedBackendService)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.WeightedBackendService)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.WeightedBackendService)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.WeightedBackendService)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.WeightedBackendService)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.WeightedBackendService)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.WeightedBackendService)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.WeightedBackendService)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.WeightedBackendService)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.WeightedBackendService)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.WeightedBackendService)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.WeightedBackendService)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.WeightedBackendService)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.WeightedBackendService)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.WeightedBackendService)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.WeightedBackendService)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.WeightedBackendService)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.WeightedBackendService)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.WeightedBackendService)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.WeightedBackendService) \nReference documentation and code samples for the Compute V1 Client class WeightedBackendService.\n\nIn contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService\n\nGenerated from protobuf message `google.cloud.compute.v1.WeightedBackendService`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBackendService\n\nThe full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.\n\n### hasBackendService\n\n### clearBackendService\n\n### setBackendService\n\nThe full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the load balancer applies any relevant headerActions specified as part of this backendServiceWeight.\n\n### getHeaderAction\n\nSpecifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.\n\n### hasHeaderAction\n\n### clearHeaderAction\n\n### setHeaderAction\n\nSpecifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.\n\n### getWeight\n\nSpecifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000.\n\n### hasWeight\n\n### clearWeight\n\n### setWeight\n\nSpecifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backend service, subsequent requests are sent to the same backend service as determined by the backend service's session affinity policy. Don't configure session affinity if you're using weighted traffic splitting. If you do, the weighted traffic splitting configuration takes precedence. The value must be from 0 to 1000."]]
