BackendService class

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 ==)

Constructors

BackendService()
BackendService.fromJson(Map _json)

Properties

affinityCookieTtlSec int
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).
read / write
backends List<Backend>
The list of backends that serve this BackendService.
read / write
cdnPolicy BackendServiceCdnPolicy
Cloud CDN configuration for this BackendService.
read / write
circuitBreakers CircuitBreakers
Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled. [...]
read / write
connectionDraining ConnectionDraining
read / write
consistentHash 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. [...]
read / write
creationTimestamp String
Output Only Creation timestamp in RFC3339 text format.
read / write
customRequestHeaders List<String>
Headers that the HTTP/S load balancer should add to proxied requests.
read / write
description String
An optional description of this resource. Provide this property when you create the resource.
read / write
enableCDN bool
If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
read / write
failoverPolicy BackendServiceFailoverPolicy
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.
read / write
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. [...]
read / write
fingerprintAsBytes List<int>
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
healthChecks List<String>
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
read / write
iap BackendServiceIAP
read / write
id String
Output Only The unique identifier for the resource. This identifier is defined by the server.
read / write
kind String
Output Only Type of resource. Always compute#backendService for backend services.
read / write
loadBalancingScheme String
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. Possible string values are: [...]
read / write
localityLbPolicy String
The load balancing algorithm used within the scope of the locality. The possible values are: [...]
read / write
logConfig 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.
read / write
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.
read / write
network String
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.
read / write
outlierDetection 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. [...]
read / write
port int
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. [...]
read / write
portName String
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. [...]
read / write
protocol String
The protocol this BackendService uses to communicate with backends. [...]
read / write
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.
read / write
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
securityPolicy String
Output Only The resource URL for the security policy associated with this backend service.
read / write
Output Only Server-defined URL for the resource.
read / write
sessionAffinity String
Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP. [...]
read / write
timeoutSec int
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.
read / write

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toJson() Map<String, Object>
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited