Reference documentation and code samples for the Compute V1 Client class BackendService.
Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * Global * Regional For more information, see Backend Services.
Generated from protobuf message google.cloud.compute.v1.BackendService
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ affinity_cookie_ttl_sec
int
Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
↳ backends
↳ cdn_policy
Google\Cloud\Compute\V1\BackendServiceCdnPolicy
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
↳ circuit_breakers
↳ compression_mode
string
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
↳ connection_draining
↳ connection_tracking_policy
Google\Cloud\Compute\V1\BackendServiceConnectionTrackingPolicy
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
↳ consistent_hash
Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettings
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
↳ creation_timestamp
string
[Output Only] Creation timestamp in RFC3339 text format.
↳ custom_request_headers
↳ custom_response_headers
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ edge_security_policy
string
[Output Only] The resource URL for the edge security policy associated with this backend service.
↳ enable_c_d_n
bool
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
↳ failover_policy
Google\Cloud\Compute\V1\BackendServiceFailoverPolicy
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing .
↳ fingerprint
string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
↳ health_checks
array
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
↳ iap
Google\Cloud\Compute\V1\BackendServiceIAP
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
↳ id
int|string
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
↳ kind
string
[Output Only] Type of resource. Always compute#backendService for backend services.
↳ load_balancing_scheme
string
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
↳ locality_lb_policies
array< Google\Cloud\Compute\V1\BackendServiceLocalityLoadBalancingPolicyConfig
>
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
↳ locality_lb_policy
string
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Check the LocalityLbPolicy enum for the list of possible values.
↳ log_config
Google\Cloud\Compute\V1\BackendServiceLogConfig
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
↳ max_stream_duration
Google\Cloud\Compute\V1\Duration
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
↳ name
string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ network
string
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
↳ outlier_detection
Google\Cloud\Compute\V1\OutlierDetection
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
↳ port
int
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
↳ port_name
string
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group . This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
↳ protocol
string
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
↳ region
string
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
↳ security_policy
string
[Output Only] The resource URL for the security policy associated with this backend service.
↳ security_settings
Google\Cloud\Compute\V1\SecuritySettings
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
↳ self_link
string
[Output Only] Server-defined URL for the resource.
↳ service_bindings
array
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
↳ session_affinity
string
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity . Check the SessionAffinity enum for the list of possible values.
↳ subsetting
↳ timeout_sec
int
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
getAffinityCookieTtlSec
Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Generated from protobuf field optional int32 affinity_cookie_ttl_sec = 369996954;
int
hasAffinityCookieTtlSec
clearAffinityCookieTtlSec
setAffinityCookieTtlSec
Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Generated from protobuf field optional int32 affinity_cookie_ttl_sec = 369996954;
var
int
$this
getBackends
The list of backends that serve this BackendService.
Generated from protobuf field repeated .google.cloud.compute.v1.Backend backends = 510839903;
Google\Protobuf\Internal\RepeatedField
setBackends
The list of backends that serve this BackendService.
Generated from protobuf field repeated .google.cloud.compute.v1.Backend backends = 510839903;
$this
getCdnPolicy
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
hasCdnPolicy
clearCdnPolicy
setCdnPolicy
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;
$this
getCircuitBreakers
Generated from protobuf field optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
hasCircuitBreakers
clearCircuitBreakers
setCircuitBreakers
Generated from protobuf field optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
$this
getCompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
Check the CompressionMode enum for the list of possible values.
Generated from protobuf field optional string compression_mode = 95520988;
string
hasCompressionMode
clearCompressionMode
setCompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
Check the CompressionMode enum for the list of possible values.
Generated from protobuf field optional string compression_mode = 95520988;
var
string
$this
getConnectionDraining
Generated from protobuf field optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
hasConnectionDraining
clearConnectionDraining
setConnectionDraining
Generated from protobuf field optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
$this
getConnectionTrackingPolicy
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;
hasConnectionTrackingPolicy
clearConnectionTrackingPolicy
setConnectionTrackingPolicy
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;
$this
getConsistentHash
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;
hasConsistentHash
clearConsistentHash
setConsistentHash
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;
$this
getCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] Creation timestamp in RFC3339 text format.
Generated from protobuf field optional string creation_timestamp = 30525366;
var
string
$this
getCustomRequestHeaders
Headers that the load balancer adds to proxied requests. See Creating custom headers .
Generated from protobuf field repeated string custom_request_headers = 27977992;
Google\Protobuf\Internal\RepeatedField
setCustomRequestHeaders
Headers that the load balancer adds to proxied requests. See Creating custom headers .
Generated from protobuf field repeated string custom_request_headers = 27977992;
var
string[]
$this
getCustomResponseHeaders
Headers that the load balancer adds to proxied responses. See Creating custom headers .
Generated from protobuf field repeated string custom_response_headers = 387539094;
Google\Protobuf\Internal\RepeatedField
setCustomResponseHeaders
Headers that the load balancer adds to proxied responses. See Creating custom headers .
Generated from protobuf field repeated string custom_response_headers = 387539094;
var
string[]
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
Generated from protobuf field optional string description = 422937596;
var
string
$this
getEdgeSecurityPolicy
[Output Only] The resource URL for the edge security policy associated with this backend service.
Generated from protobuf field optional string edge_security_policy = 41036943;
string
hasEdgeSecurityPolicy
clearEdgeSecurityPolicy
setEdgeSecurityPolicy
[Output Only] The resource URL for the edge security policy associated with this backend service.
Generated from protobuf field optional string edge_security_policy = 41036943;
var
string
$this
getEnableCDN
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
Generated from protobuf field optional bool enable_c_d_n = 250733499;
bool
hasEnableCDN
clearEnableCDN
setEnableCDN
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
Generated from protobuf field optional bool enable_c_d_n = 250733499;
var
bool
$this
getFailoverPolicy
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing .
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
hasFailoverPolicy
clearFailoverPolicy
setFailoverPolicy
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing .
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
$this
getFingerprint
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
Generated from protobuf field optional string fingerprint = 234678500;
string
hasFingerprint
clearFingerprint
setFingerprint
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
Generated from protobuf field optional string fingerprint = 234678500;
var
string
$this
getHealthChecks
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
Generated from protobuf field repeated string health_checks = 448370606;
Google\Protobuf\Internal\RepeatedField
setHealthChecks
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
Generated from protobuf field repeated string health_checks = 448370606;
var
string[]
$this
getIap
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;
hasIap
clearIap
setIap
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;
$this
getId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
int|string
hasId
clearId
setId
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Generated from protobuf field optional uint64 id = 3355;
var
int|string
$this
getKind
[Output Only] Type of resource. Always compute#backendService for backend services.
Generated from protobuf field optional string kind = 3292052;
string
hasKind
clearKind
setKind
[Output Only] Type of resource. Always compute#backendService for backend services.
Generated from protobuf field optional string kind = 3292052;
var
string
$this
getLoadBalancingScheme
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Check the LoadBalancingScheme enum for the list of possible values.
Generated from protobuf field optional string load_balancing_scheme = 363890244;
string
hasLoadBalancingScheme
clearLoadBalancingScheme
setLoadBalancingScheme
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer.
Check the LoadBalancingScheme enum for the list of possible values.
Generated from protobuf field optional string load_balancing_scheme = 363890244;
var
string
$this
getLocalityLbPolicies
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
Google\Protobuf\Internal\RepeatedField
setLocalityLbPolicies
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
$this
getLocalityLbPolicy
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Check the LocalityLbPolicy enum for the list of possible values.
Generated from protobuf field optional string locality_lb_policy = 131431487;
string
hasLocalityLbPolicy
clearLocalityLbPolicy
setLocalityLbPolicy
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
Check the LocalityLbPolicy enum for the list of possible values.
Generated from protobuf field optional string locality_lb_policy = 131431487;
var
string
$this
getLogConfig
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;
hasLogConfig
clearLogConfig
setLogConfig
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
Generated from protobuf field optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;
$this
getMaxStreamDuration
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;
hasMaxStreamDuration
clearMaxStreamDuration
setMaxStreamDuration
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;
$this
getName
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Generated from protobuf field optional string name = 3373707;
string
hasName
clearName
setName
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Generated from protobuf field optional string name = 3373707;
var
string
$this
getNetwork
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Generated from protobuf field optional string network = 232872494;
string
hasNetwork
clearNetwork
setNetwork
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
Generated from protobuf field optional string network = 232872494;
var
string
$this
getOutlierDetection
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;
hasOutlierDetection
clearOutlierDetection
setOutlierDetection
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;
$this
getPort
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Generated from protobuf field optional int32 port = 3446913;
int
hasPort
clearPort
setPort
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
Generated from protobuf field optional int32 port = 3446913;
var
int
$this
getPortName
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group . This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
Generated from protobuf field optional string port_name = 41534345;
string
hasPortName
clearPortName
setPortName
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be defined on each backend instance group . This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
Generated from protobuf field optional string port_name = 41534345;
var
string
$this
getProtocol
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Check the Protocol enum for the list of possible values.
Generated from protobuf field optional string protocol = 84577944;
string
hasProtocol
clearProtocol
setProtocol
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy.
Check the Protocol enum for the list of possible values.
Generated from protobuf field optional string protocol = 84577944;
var
string
$this
getRegion
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Generated from protobuf field optional string region = 138946292;
string
hasRegion
clearRegion
setRegion
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Generated from protobuf field optional string region = 138946292;
var
string
$this
getSecurityPolicy
[Output Only] The resource URL for the security policy associated with this backend service.
Generated from protobuf field optional string security_policy = 171082513;
string
hasSecurityPolicy
clearSecurityPolicy
setSecurityPolicy
[Output Only] The resource URL for the security policy associated with this backend service.
Generated from protobuf field optional string security_policy = 171082513;
var
string
$this
getSecuritySettings
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;
hasSecuritySettings
clearSecuritySettings
setSecuritySettings
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
Generated from protobuf field optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;
$this
getSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
string
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] Server-defined URL for the resource.
Generated from protobuf field optional string self_link = 456214797;
var
string
$this
getServiceBindings
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
Generated from protobuf field repeated string service_bindings = 133581016;
Google\Protobuf\Internal\RepeatedField
setServiceBindings
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
Generated from protobuf field repeated string service_bindings = 133581016;
var
string[]
$this
getSessionAffinity
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity .
Check the SessionAffinity enum for the list of possible values.
Generated from protobuf field optional string session_affinity = 463888561;
string
hasSessionAffinity
clearSessionAffinity
setSessionAffinity
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: Session Affinity .
Check the SessionAffinity enum for the list of possible values.
Generated from protobuf field optional string session_affinity = 463888561;
var
string
$this
getSubsetting
Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
hasSubsetting
clearSubsetting
setSubsetting
Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
$this
getTimeoutSec
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Generated from protobuf field optional int32 timeout_sec = 79994995;
int
hasTimeoutSec
clearTimeoutSec
setTimeoutSec
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
Generated from protobuf field optional int32 timeout_sec = 79994995;
var
int
$this
