Class BackendService (1.4.0) 

BackendService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 <https://cloud.google.com/compute/docs/reference/rest/v1/backendServices> * Regional <https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices> For more information, see Backend Services.

Attributes

NameDescription
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. This field is a member of oneof_ _affinity_cookie_ttl_sec.
backends Sequence[google.cloud.compute_v1.types.Backend]
The list of backends that serve this BackendService.
cdn_policy google.cloud.compute_v1.types.BackendServiceCdnPolicy
Cloud CDN configuration for this BackendService. Only available for specified load balancer types. This field is a member of oneof_ _cdn_policy.
circuit_breakers google.cloud.compute_v1.types.CircuitBreakers
This field is a member of oneof_ _circuit_breakers.
connection_draining google.cloud.compute_v1.types.ConnectionDraining
This field is a member of oneof_ _connection_draining.
connection_tracking_policy google.cloud.compute_v1.types.BackendServiceConnectionTrackingPolicy
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing. This field is a member of oneof_ _connection_tracking_policy.
consistent_hash google.cloud.compute_v1.types.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. This field is a member of oneof_ _consistent_hash.
creation_timestamp str
[Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
custom_request_headers Sequence[str]
Headers that the load balancer adds to proxied requests. See `Creating custom headers
custom_response_headers Sequence[str]
Headers that the load balancer adds to proxied responses. See `Creating custom headers
description str
An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
edge_security_policy str
[Output Only] The resource URL for the edge security policy associated with this backend service. This field is a member of oneof_ _edge_security_policy.
enable_c_d_n bool
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. This field is a member of oneof_ _enable_c_d_n.
failover_policy google.cloud.compute_v1.types.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
fingerprint str
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. This field is a member of oneof_ _fingerprint.
health_checks Sequence[str]
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.types.BackendServiceIAP
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing. This field is a member of oneof_ _iap.
id int
[Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind str
[Output Only] Type of resource. Always compute#backendService for backend services. This field is a member of oneof_ _kind.
load_balancing_scheme str
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. This field is a member of oneof_ _load_balancing_scheme.
locality_lb_policies Sequence[google.cloud.compute_v1.types.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 str
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. This field is a member of oneof_ _locality_lb_policy.
log_config google.cloud.compute_v1.types.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. This field is a member of oneof_ _log_config.
max_stream_duration google.cloud.compute_v1.types.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. This field is a member of oneof_ _max_stream_duration.
name str
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. This field is a member of oneof_ _name.
network str
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. This field is a member of oneof_ _network.
outlier_detection google.cloud.compute_v1.types.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, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. 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. This field is a member of oneof_ _outlier_detection.
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. This field is a member of oneof_ _port.
port_name str
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
protocol str
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. This field is a member of oneof_ _protocol.
region str
[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. This field is a member of oneof_ _region.
security_policy str
[Output Only] The resource URL for the security policy associated with this backend service. This field is a member of oneof_ _security_policy.
security_settings google.cloud.compute_v1.types.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. This field is a member of oneof_ _security_settings.
self_link str
[Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
service_bindings Sequence[str]
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 str
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
subsetting google.cloud.compute_v1.types.Subsetting
This field is a member of oneof_ _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. This field is a member of oneof_ _timeout_sec.

Classes

LoadBalancingScheme

LoadBalancingScheme(value)

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.

LocalityLbPolicy

LocalityLbPolicy(value)

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.

Protocol

Protocol(value)

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.

SessionAffinity

SessionAffinity(value)

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 <https://cloud.google.com/load-balancing/docs/backend-service#session_affinity>__.