Compute V1 Client - Class BackendService (1.19.0)

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ affinity_cookie_ttl_sec`	`int` Lifetime of cookies in seconds. This setting is applicable to Application 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`	`array<Google\Cloud\Compute\V1\Backend>` The list of backends that serve this BackendService.
`↳ cdn_policy`	`Google\Cloud\Compute\V1\BackendServiceCdnPolicy` Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
`↳ circuit_breakers`	`Google\Cloud\Compute\V1\CircuitBreakers`
`↳ 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`	`Google\Cloud\Compute\V1\ConnectionDraining`
`↳ connection_tracking_policy`	`Google\Cloud\Compute\V1\BackendServiceConnectionTrackingPolicy` Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers.
`↳ 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`	`array` Headers that the load balancer adds to proxied requests. See Creating custom headers.
`↳ custom_response_headers`	`array` Headers that the load balancer adds to proxied responses. See Creating custom 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 a global external Application 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 passthrough Network Load Balancers and external passthrough Network Load Balancers.
`↳ 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 passthrough Network Load Balancers and external passthrough Network Load Balancers.
`↳ 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. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
`↳ 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, INTERNAL_MANAGED, or EXTERNAL_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.
`↳ metadatas`	`array\|Google\Protobuf\Internal\MapField` Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
`↳ 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 ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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.
`↳ port`	`int` Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, 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.
`↳ service_lb_policy`	`string` URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
`↳ 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`	`Google\Cloud\Compute\V1\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.
`↳ used_by`	`array<Google\Cloud\Compute\V1\BackendServiceUsedBy>`

getAffinityCookieTtlSec

Lifetime of cookies in seconds. This setting is applicable to Application 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.

Returns
Type	Description
`int`

hasAffinityCookieTtlSec

clearAffinityCookieTtlSec

setAffinityCookieTtlSec

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getBackends

The list of backends that serve this BackendService.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setBackends

The list of backends that serve this BackendService.

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\Backend>`

Returns
Type	Description
`$this`

getCdnPolicy

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

Returns
Type	Description
`Google\Cloud\Compute\V1\BackendServiceCdnPolicy\|null`

hasCdnPolicy

clearCdnPolicy

setCdnPolicy

Cloud CDN configuration for this BackendService. Only available for specified load balancer types.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\BackendServiceCdnPolicy`

Returns
Type	Description
`$this`

getCircuitBreakers

Generated from protobuf field optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Returns
Type	Description
`Google\Cloud\Compute\V1\CircuitBreakers\|null`

hasCircuitBreakers

clearCircuitBreakers

setCircuitBreakers

Generated from protobuf field optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CircuitBreakers`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConnectionDraining

Generated from protobuf field optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Returns
Type	Description
`Google\Cloud\Compute\V1\ConnectionDraining\|null`

hasConnectionDraining

clearConnectionDraining

setConnectionDraining

Generated from protobuf field optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\ConnectionDraining`

Returns
Type	Description
`$this`

getConnectionTrackingPolicy

Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers.

Returns
Type	Description
`Google\Cloud\Compute\V1\BackendServiceConnectionTrackingPolicy\|null`

hasConnectionTrackingPolicy

clearConnectionTrackingPolicy

setConnectionTrackingPolicy

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\BackendServiceConnectionTrackingPolicy`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettings\|null`

hasConsistentHash

clearConsistentHash

setConsistentHash

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettings`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomRequestHeaders

Headers that the load balancer adds to proxied requests. See Creating custom headers.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCustomRequestHeaders

Headers that the load balancer adds to proxied requests. See Creating custom headers.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCustomResponseHeaders

Headers that the load balancer adds to proxied responses. See Creating custom headers.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCustomResponseHeaders

Headers that the load balancer adds to proxied responses. See Creating custom headers.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEdgeSecurityPolicy

[Output Only] The resource URL for the edge security policy associated with this backend service.

Returns
Type	Description
`string`

hasEdgeSecurityPolicy

clearEdgeSecurityPolicy

setEdgeSecurityPolicy

[Output Only] The resource URL for the edge security policy associated with this backend service.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableCDN

If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.

Returns
Type	Description
`bool`

hasEnableCDN

clearEnableCDN

setEnableCDN

If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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 passthrough Network Load Balancers and external passthrough Network Load Balancers.

Returns
Type	Description
`Google\Cloud\Compute\V1\BackendServiceFailoverPolicy\|null`

hasFailoverPolicy

clearFailoverPolicy

setFailoverPolicy

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\BackendServiceFailoverPolicy`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasFingerprint

clearFingerprint

setFingerprint

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setHealthChecks

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getIap

The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

Returns
Type	Description
`Google\Cloud\Compute\V1\BackendServiceIAP\|null`

hasIap

clearIap

setIap

The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\BackendServiceIAP`

Returns
Type	Description
`$this`

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getKind

[Output Only] Type of resource. Always compute#backendService for backend services.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] Type of resource. Always compute#backendService for backend services.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLocalityLbPolicies

A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLocalityLbPolicies

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\BackendServiceLocalityLoadBalancingPolicyConfig>`

Returns
Type	Description
`$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, INTERNAL_MANAGED, or EXTERNAL_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.

Returns
Type	Description
`string`

hasLocalityLbPolicy

clearLocalityLbPolicy

setLocalityLbPolicy

Check the LocalityLbPolicy enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Cloud\Compute\V1\BackendServiceLogConfig\|null`

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.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\BackendServiceLogConfig`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Cloud\Compute\V1\Duration\|null`

hasMaxStreamDuration

clearMaxStreamDuration

setMaxStreamDuration

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\Duration`

Returns
Type	Description
`$this`

getMetadatas

Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setMetadatas

Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOutlierDetection

Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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.

Returns
Type	Description
`Google\Cloud\Compute\V1\OutlierDetection\|null`

hasOutlierDetection

clearOutlierDetection

setOutlierDetection

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\OutlierDetection`

Returns
Type	Description
`$this`

getPort

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.

Returns
Type	Description
`int`

hasPort

clearPort

setPort

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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 passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.

Returns
Type	Description
`string`

hasPortName

clearPortName

setPortName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasProtocol

clearProtocol

setProtocol

Check the Protocol enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSecurityPolicy

[Output Only] The resource URL for the security policy associated with this backend service.

Returns
Type	Description
`string`

hasSecurityPolicy

clearSecurityPolicy

setSecurityPolicy

[Output Only] The resource URL for the security policy associated with this backend service.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Cloud\Compute\V1\SecuritySettings\|null`

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.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\SecuritySettings`

Returns
Type	Description
`$this`

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getServiceLbPolicy

URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

Returns
Type	Description
`string`

hasServiceLbPolicy

clearServiceLbPolicy

setServiceLbPolicy

URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasSessionAffinity

clearSessionAffinity

setSessionAffinity

Check the SessionAffinity enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSubsetting

Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Returns
Type	Description
`Google\Cloud\Compute\V1\Subsetting\|null`

hasSubsetting

clearSubsetting

setSubsetting

Generated from protobuf field optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\Subsetting`

Returns
Type	Description
`$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.

Returns
Type	Description
`int`

hasTimeoutSec

clearTimeoutSec

setTimeoutSec

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUsedBy

Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setUsedBy

Generated from protobuf field repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\BackendServiceUsedBy>`

Returns
Type	Description
`$this`