public sealed class BackendService : IMessage<BackendService>, IEquatable<BackendService>, IDeepCloneable<BackendService>, IBufferMessage, IMessage
Reference documentation and code samples for the Compute Engine v1 API 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.
Inheritance
object >
BackendService
Namespace
Google.Cloud.Compute.V1
Assembly
Google.Cloud.Compute.V1.dll
Constructors
BackendService()
BackendService(BackendService)
public BackendService(BackendService other)
Properties
AffinityCookieTtlSec
public int AffinityCookieTtlSec { get; set; }
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.
| Property Value |
|---|
| Type | Description |
int | |
Backends
public RepeatedField<Backend> Backends { get; }
The list of backends that serve this BackendService.
CdnPolicy
public BackendServiceCdnPolicy CdnPolicy { get; set; }
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
CircuitBreakers
public CircuitBreakers CircuitBreakers { get; set; }
CompressionMode
public string CompressionMode { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
ConnectionDraining
public ConnectionDraining ConnectionDraining { get; set; }
ConnectionTrackingPolicy
public BackendServiceConnectionTrackingPolicy ConnectionTrackingPolicy { get; set; }
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.
ConsistentHash
public ConsistentHashLoadBalancerSettings ConsistentHash { get; set; }
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.
CreationTimestamp
public string CreationTimestamp { get; set; }
[Output Only] Creation timestamp in RFC3339 text format.
| Property Value |
|---|
| Type | Description |
string | |
public RepeatedField<string> CustomRequestHeaders { get; }
public RepeatedField<string> CustomResponseHeaders { get; }
Description
public string Description { get; set; }
An optional description of this resource. Provide this property when you create the resource.
| Property Value |
|---|
| Type | Description |
string | |
EdgeSecurityPolicy
public string EdgeSecurityPolicy { get; set; }
[Output Only] The resource URL for the edge security policy associated with this backend service.
| Property Value |
|---|
| Type | Description |
string | |
EnableCDN
public bool EnableCDN { get; set; }
If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.
| Property Value |
|---|
| Type | Description |
bool | |
FailoverPolicy
public BackendServiceFailoverPolicy FailoverPolicy { get; set; }
Fingerprint
public string Fingerprint { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
HasAffinityCookieTtlSec
public bool HasAffinityCookieTtlSec { get; }
Gets whether the "affinity_cookie_ttl_sec" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasCompressionMode
public bool HasCompressionMode { get; }
Gets whether the "compression_mode" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasCreationTimestamp
public bool HasCreationTimestamp { get; }
Gets whether the "creation_timestamp" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasDescription
public bool HasDescription { get; }
Gets whether the "description" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasEdgeSecurityPolicy
public bool HasEdgeSecurityPolicy { get; }
Gets whether the "edge_security_policy" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasEnableCDN
public bool HasEnableCDN { get; }
Gets whether the "enable_c_d_n" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasFingerprint
public bool HasFingerprint { get; }
Gets whether the "fingerprint" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasId
public bool HasId { get; }
Gets whether the "id" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasKind
public bool HasKind { get; }
Gets whether the "kind" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasLoadBalancingScheme
public bool HasLoadBalancingScheme { get; }
Gets whether the "load_balancing_scheme" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasLocalityLbPolicy
public bool HasLocalityLbPolicy { get; }
Gets whether the "locality_lb_policy" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasName
public bool HasName { get; }
Gets whether the "name" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasNetwork
public bool HasNetwork { get; }
Gets whether the "network" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasPort
public bool HasPort { get; }
Gets whether the "port" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasPortName
public bool HasPortName { get; }
Gets whether the "port_name" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasProtocol
public bool HasProtocol { get; }
Gets whether the "protocol" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasRegion
public bool HasRegion { get; }
Gets whether the "region" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasSecurityPolicy
public bool HasSecurityPolicy { get; }
Gets whether the "security_policy" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasSelfLink
public bool HasSelfLink { get; }
Gets whether the "self_link" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasServiceLbPolicy
public bool HasServiceLbPolicy { get; }
Gets whether the "service_lb_policy" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasSessionAffinity
public bool HasSessionAffinity { get; }
Gets whether the "session_affinity" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HasTimeoutSec
public bool HasTimeoutSec { get; }
Gets whether the "timeout_sec" field is set
| Property Value |
|---|
| Type | Description |
bool | |
HealthChecks
public RepeatedField<string> HealthChecks { get; }
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
public BackendServiceIAP Iap { get; set; }
The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.
Id
public ulong Id { get; set; }
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
| Property Value |
|---|
| Type | Description |
ulong | |
Kind
public string Kind { get; set; }
[Output Only] Type of resource. Always compute#backendService for backend services.
| Property Value |
|---|
| Type | Description |
string | |
LoadBalancingScheme
public string LoadBalancingScheme { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
LocalityLbPolicies
public RepeatedField<BackendServiceLocalityLoadBalancingPolicyConfig> LocalityLbPolicies { get; }
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.
LocalityLbPolicy
public string LocalityLbPolicy { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
LogConfig
public BackendServiceLogConfig LogConfig { get; set; }
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.
MaxStreamDuration
public Duration MaxStreamDuration { get; set; }
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.
public MapField<string, string> Metadatas { get; }
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
Name
public string Name { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
Network
public string Network { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
OutlierDetection
public OutlierDetection OutlierDetection { get; set; }
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
public int Port { get; set; }
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.
| Property Value |
|---|
| Type | Description |
int | |
PortName
public string PortName { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
Protocol
public string Protocol { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
Region
public string Region { get; set; }
[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.
| Property Value |
|---|
| Type | Description |
string | |
SecurityPolicy
public string SecurityPolicy { get; set; }
[Output Only] The resource URL for the security policy associated with this backend service.
| Property Value |
|---|
| Type | Description |
string | |
SecuritySettings
public SecuritySettings SecuritySettings { get; set; }
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.
SelfLink
public string SelfLink { get; set; }
[Output Only] Server-defined URL for the resource.
| Property Value |
|---|
| Type | Description |
string | |
ServiceBindings
public RepeatedField<string> ServiceBindings { get; }
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.
ServiceLbPolicy
public string ServiceLbPolicy { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
SessionAffinity
public string SessionAffinity { get; set; }
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.
| Property Value |
|---|
| Type | Description |
string | |
Subsetting
public Subsetting Subsetting { get; set; }
TimeoutSec
public int TimeoutSec { get; set; }
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.
| Property Value |
|---|
| Type | Description |
int | |
UsedBy
public RepeatedField<BackendServiceUsedBy> UsedBy { get; }
