class Google::Apis::ComputeV1::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](cloud.google.com/ compute/docs/reference/rest/v1/backendServices) * [Regional](cloud. google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.

Attributes

backends[RW]

The list of backends that serve this BackendService. Corresponds to the JSON property `backends` @return [Array<Google::Apis::ComputeV1::Backend>]

cdn_policy[RW]

Message containing Cloud CDN configuration for a backend service. Corresponds to the JSON property `cdnPolicy` @return [Google::Apis::ComputeV1::BackendServiceCdnPolicy]

circuit_breakers[RW]

Settings controlling the volume of requests, connections and retries to this backend service. Corresponds to the JSON property `circuitBreakers` @return [Google::Apis::ComputeV1::CircuitBreakers]

compression_mode[RW]

Compress text responses using Brotli or gzip compression, based on the client' s Accept-Encoding header. Corresponds to the JSON property `compressionMode` @return [String]

connection_draining[RW]

Message containing connection draining configuration. Corresponds to the JSON property `connectionDraining` @return [Google::Apis::ComputeV1::ConnectionDraining]

connection_tracking_policy[RW]

Connection Tracking configuration for this BackendService. Corresponds to the JSON property `connectionTrackingPolicy` @return [Google::Apis::ComputeV1::BackendServiceConnectionTrackingPolicy]

consistent_hash[RW]

This message defines settings for a consistent hash style load balancer. Corresponds to the JSON property `consistentHash` @return [Google::Apis::ComputeV1::ConsistentHashLoadBalancerSettings]

creation_timestamp[RW]
Output Only

Creation timestamp in RFC3339 text format.

Corresponds to the JSON property `creationTimestamp` @return [String]

custom_request_headers[RW]

Headers that the load balancer adds to proxied requests. See [Creating custom headers](cloud.google.com/load-balancing/docs/custom-headers). Corresponds to the JSON property `customRequestHeaders` @return [Array<String>]

custom_response_headers[RW]

Headers that the load balancer adds to proxied responses. See [Creating custom headers](cloud.google.com/load-balancing/docs/custom-headers). Corresponds to the JSON property `customResponseHeaders` @return [Array<String>]

description[RW]

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]

edge_security_policy[RW]
Output Only

The resource URL for the edge security policy associated with

this backend service. Corresponds to the JSON property `edgeSecurityPolicy` @return [String]

enable_cdn[RW]

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. Corresponds to the JSON property `enableCDN` @return [Boolean]

enable_cdn?[RW]

If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. Corresponds to the JSON property `enableCDN` @return [Boolean]

failover_policy[RW]

For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](cloud.google.com/load-balancing/docs/internal/failover- overview) and [external TCP/UDP Load Balancing](cloud.google.com/load- balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). Corresponds to the JSON property `failoverPolicy` @return [Google::Apis::ComputeV1::BackendServiceFailoverPolicy]

fingerprint[RW]

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. Corresponds to the JSON property `fingerprint` NOTE: Values are automatically base64 encoded/decoded in the client library. @return [String]

health_checks[RW]

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. Corresponds to the JSON property `healthChecks` @return [Array<String>]

iap[RW]

Identity-Aware Proxy Corresponds to the JSON property `iap` @return [Google::Apis::ComputeV1::BackendServiceIap]

id[RW]
Output Only

The unique identifier for the resource. This identifier is

defined by the server. Corresponds to the JSON property `id` @return [Fixnum]

kind[RW]
Output Only

Type of resource. Always compute#backendService for backend

services. Corresponds to the JSON property `kind` @return [String]

load_balancing_scheme[RW]

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. Corresponds to the JSON property `loadBalancingScheme` @return [String]

locality_lb_policies[RW]

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. Corresponds to the JSON property `localityLbPolicies` @return [Array<Google::Apis::ComputeV1::BackendServiceLocalityLoadBalancingPolicyConfig>]

locality_lb_policy[RW]

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 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. Corresponds to the JSON property `localityLbPolicy` @return [String]

log_config[RW]

The available logging options for the load balancer traffic served by this backend service. Corresponds to the JSON property `logConfig` @return [Google::Apis::ComputeV1::BackendServiceLogConfig]

max_stream_duration[RW]

A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like “day” or “month”. Range is approximately 10, 000 years. Corresponds to the JSON property `maxStreamDuration` @return [Google::Apis::ComputeV1::Duration]

name[RW]

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]*)?` 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. Corresponds to the JSON property `name` @return [String]

network[RW]

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. Corresponds to the JSON property `network` @return [String]

outlier_detection[RW]

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. Corresponds to the JSON property `outlierDetection` @return [Google::Apis::ComputeV1::OutlierDetection]

port[RW]

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. Corresponds to the JSON property `port` @return [Fixnum]

port_name[RW]

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](cloud.google.com/load- balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. Corresponds to the JSON property `portName` @return [String]

protocol[RW]

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. Corresponds to the JSON property `protocol` @return [String]

region[RW]
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. Corresponds to the JSON property `region` @return [String]

security_policy[RW]
Output Only

The resource URL for the security policy associated with this

backend service. Corresponds to the JSON property `securityPolicy` @return [String]

security_settings[RW]

The authentication and authorization settings for a BackendService. Corresponds to the JSON property `securitySettings` @return [Google::Apis::ComputeV1::SecuritySettings]

service_bindings[RW]

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. Corresponds to the JSON property `serviceBindings` @return [Array<String>]

session_affinity[RW]

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](cloud.google.com/load- balancing/docs/backend-service#session_affinity). Corresponds to the JSON property `sessionAffinity` @return [String]

subsetting[RW]

Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. Corresponds to the JSON property `subsetting` @return [Google::Apis::ComputeV1::Subsetting]

timeout_sec[RW]

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. Corresponds to the JSON property `timeoutSec` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/compute_v1/classes.rb, line 3368
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/compute_v1/classes.rb, line 3373
def update!(**args)
  @affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec)
  @backends = args[:backends] if args.key?(:backends)
  @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy)
  @circuit_breakers = args[:circuit_breakers] if args.key?(:circuit_breakers)
  @compression_mode = args[:compression_mode] if args.key?(:compression_mode)
  @connection_draining = args[:connection_draining] if args.key?(:connection_draining)
  @connection_tracking_policy = args[:connection_tracking_policy] if args.key?(:connection_tracking_policy)
  @consistent_hash = args[:consistent_hash] if args.key?(:consistent_hash)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers)
  @custom_response_headers = args[:custom_response_headers] if args.key?(:custom_response_headers)
  @description = args[:description] if args.key?(:description)
  @edge_security_policy = args[:edge_security_policy] if args.key?(:edge_security_policy)
  @enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn)
  @failover_policy = args[:failover_policy] if args.key?(:failover_policy)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @health_checks = args[:health_checks] if args.key?(:health_checks)
  @iap = args[:iap] if args.key?(:iap)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
  @locality_lb_policies = args[:locality_lb_policies] if args.key?(:locality_lb_policies)
  @locality_lb_policy = args[:locality_lb_policy] if args.key?(:locality_lb_policy)
  @log_config = args[:log_config] if args.key?(:log_config)
  @max_stream_duration = args[:max_stream_duration] if args.key?(:max_stream_duration)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @outlier_detection = args[:outlier_detection] if args.key?(:outlier_detection)
  @port = args[:port] if args.key?(:port)
  @port_name = args[:port_name] if args.key?(:port_name)
  @protocol = args[:protocol] if args.key?(:protocol)
  @region = args[:region] if args.key?(:region)
  @security_policy = args[:security_policy] if args.key?(:security_policy)
  @security_settings = args[:security_settings] if args.key?(:security_settings)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_bindings = args[:service_bindings] if args.key?(:service_bindings)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @subsetting = args[:subsetting] if args.key?(:subsetting)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end