Class BackendService

Represents a Backend Service resource.

A backend service contains configuration values for Google Cloud Platform load balancing services.

Backend services in Google Compute Engine can be either regionally or globally scoped.

For more information, read Backend Services.

(== resource_for {$api_version}.backendService ==)

Inheritance
System.Object
BackendService
Implements
Google.Apis.Requests.IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Compute.v1.Data
Assembly: Google.Apis.Compute.v1.dll
Syntax
public class BackendService : IDirectResponseSchema

Properties

AffinityCookieTtlSec

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 one day (86,400).

Declaration
[JsonProperty("affinityCookieTtlSec")]
public virtual int? AffinityCookieTtlSec { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Backends

The list of backends that serve this BackendService.

Declaration
[JsonProperty("backends")]
public virtual IList<Backend> Backends { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<Backend>

CdnPolicy

Cloud CDN configuration for this BackendService.

Declaration
[JsonProperty("cdnPolicy")]
public virtual BackendServiceCdnPolicy CdnPolicy { get; set; }
Property Value
Type Description
BackendServiceCdnPolicy

CircuitBreakers

Settings controlling the volume of connections to a 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.

Declaration
[JsonProperty("circuitBreakers")]
public virtual CircuitBreakers CircuitBreakers { get; set; }
Property Value
Type Description
CircuitBreakers

ConnectionDraining

Declaration
[JsonProperty("connectionDraining")]
public virtual ConnectionDraining ConnectionDraining { get; set; }
Property Value
Type Description
ConnectionDraining

ConsistentHash

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.

Declaration
[JsonProperty("consistentHash")]
public virtual ConsistentHashLoadBalancerSettings ConsistentHash { get; set; }
Property Value
Type Description
ConsistentHashLoadBalancerSettings

CreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
System.String

CustomRequestHeaders

Headers that the HTTP/S load balancer should add to proxied requests.

Declaration
[JsonProperty("customRequestHeaders")]
public virtual IList<string> CustomRequestHeaders { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

Description

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

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
System.String

EnableCDN

If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.

Declaration
[JsonProperty("enableCDN")]
public virtual bool? EnableCDN { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

FailoverPolicy

Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend.

Declaration
[JsonProperty("failoverPolicy")]
public virtual BackendServiceFailoverPolicy FailoverPolicy { get; set; }
Property Value
Type Description
BackendServiceFailoverPolicy

Fingerprint

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.

Declaration
[JsonProperty("fingerprint")]
public virtual string Fingerprint { get; set; }
Property Value
Type Description
System.String

HealthChecks

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. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must

Declaration
[JsonProperty("healthChecks")]
public virtual IList<string> HealthChecks { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

Iap

Declaration
[JsonProperty("iap")]
public virtual BackendServiceIAP Iap { get; set; }
Property Value
Type Description
BackendServiceIAP

Id

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

Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type Description
System.Nullable<System.UInt64>

Kind

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

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
System.String

LoadBalancingScheme

Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.

Declaration
[JsonProperty("loadBalancingScheme")]
public virtual string LoadBalancingScheme { get; set; }
Property Value
Type Description
System.String

LocalityLbPolicy

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, refer to 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.

Declaration
[JsonProperty("localityLbPolicy")]
public virtual string LocalityLbPolicy { get; set; }
Property Value
Type Description
System.String

LogConfig

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.

Declaration
[JsonProperty("logConfig")]
public virtual BackendServiceLogConfig LogConfig { get; set; }
Property Value
Type Description
BackendServiceLogConfig

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.String

Network

The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.

Declaration
[JsonProperty("network")]
public virtual string Network { get; set; }
Property Value
Type Description
System.String

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.

Declaration
[JsonProperty("outlierDetection")]
public virtual OutlierDetection OutlierDetection { get; set; }
Property Value
Type Description
OutlierDetection

Port

Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.

This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Declaration
[JsonProperty("port")]
public virtual int? Port { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

PortName

A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.

Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).

Declaration
[JsonProperty("portName")]
public virtual string PortName { get; set; }
Property Value
Type Description
System.String

Protocol

The protocol this BackendService uses to communicate with backends.

Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.

Declaration
[JsonProperty("protocol")]
public virtual string Protocol { get; set; }
Property Value
Type Description
System.String

Region

[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.

Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type Description
System.String

SecurityPolicy

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

Declaration
[JsonProperty("securityPolicy")]
public virtual string SecurityPolicy { get; set; }
Property Value
Type Description
System.String

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

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
System.String

SessionAffinity

Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.

When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.

When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.

Declaration
[JsonProperty("sessionAffinity")]
public virtual string SessionAffinity { get; set; }
Property Value
Type Description
System.String

TimeoutSec

The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.

Declaration
[JsonProperty("timeoutSec")]
public virtual int? TimeoutSec { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Implements

Google.Apis.Requests.IDirectResponseSchema