Represents a Backend Service resource. More...
Properties | |
| virtual System.Nullable< int > | AffinityCookieTtlSec [get, set] |
| 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). More... | |
| virtual System.Collections.Generic.IList< Backend > | Backends [get, set] |
| The list of backends that serve this BackendService. More... | |
| virtual BackendServiceCdnPolicy | CdnPolicy [get, set] |
| Cloud CDN configuration for this BackendService. More... | |
| virtual CircuitBreakers | CircuitBreakers [get, set] |
| Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled. More... | |
| virtual ConnectionDraining | ConnectionDraining [get, set] |
| virtual 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. More... | |
| virtual string | CreationTimestamp [get, set] |
| [Output Only] Creation timestamp in RFC3339 text format. More... | |
| virtual System.Collections.Generic.IList< string > | CustomRequestHeaders [get, set] |
| Headers that the HTTP/S load balancer should add to proxied requests. More... | |
| virtual string | Description [get, set] |
| An optional description of this resource. Provide this property when you create the resource. More... | |
| virtual System.Nullable< bool > | EnableCDN [get, set] |
| If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS. More... | |
| virtual 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. More... | |
| virtual System.Collections.Generic.IList< string > | HealthChecks [get, set] |
| The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified. Health check is optional for Compute Engine backend services if there is no backend. A health check must not be specified when adding Internet Network Endpoint Group or Serverless Network Endpoint Group as backends. In all other cases, a health check is required for Compute Engine backend services. More... | |
| virtual BackendServiceIAP | Iap [get, set] |
| virtual System.Nullable< ulong > | Id [get, set] |
| [Output Only] The unique identifier for the resource. This identifier is defined by the server. More... | |
| virtual string | Kind [get, set] |
| [Output Only] Type of resource. Always compute::backendService for backend services. More... | |
| virtual string | LoadBalancingScheme [get, set] |
| 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. More... | |
| virtual 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, refer to https://ai.google/research/pubs/pub44824 More... | |
| virtual 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. More... | |
| virtual 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. More... | |
| virtual string | Network [get, set] |
| 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. More... | |
| virtual OutlierDetection | OutlierDetection [get, set] |
| Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. More... | |
| virtual System.Nullable< int > | Port [get, set] |
| Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. More... | |
| virtual string | PortName [get, set] |
| 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 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. More... | |
| virtual string | Protocol [get, set] |
| The protocol this BackendService uses to communicate with backends. More... | |
| virtual 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. More... | |
| virtual string | SecurityPolicy [get, set] |
| [Output Only] The resource URL for the security policy associated with this backend service. More... | |
| virtual string | SelfLink [get, set] |
| [Output Only] Server-defined URL for the resource. More... | |
| virtual string | SessionAffinity [get, set] |
| Type of session affinity to use. The default is NONE. Session affinity is not applicable if the –protocol is UDP. More... | |
| virtual System.Nullable< int > | TimeoutSec [get, set] |
| 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. More... | |
| virtual string | ETag [get, set] |
| The ETag of the item. More... | |
 Properties inherited from Google::Apis::Requests::IDirectResponseSchema | |
| string | ETag |
Detailed Description
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 ==)
Property Documentation
◆ AffinityCookieTtlSec
|
getset |
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).
◆ Backends
|
getset |
The list of backends that serve this BackendService.
◆ CdnPolicy
|
getset |
Cloud CDN configuration for this BackendService.
◆ CircuitBreakers
|
getset |
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.
◆ ConsistentHash
|
getset |
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
|
getset |
[Output Only] Creation timestamp in RFC3339 text format.
◆ CustomRequestHeaders
|
getset |
Headers that the HTTP/S load balancer should add to proxied requests.
◆ Description
|
getset |
An optional description of this resource. Provide this property when you create the resource.
◆ EnableCDN
|
getset |
If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
◆ ETag
|
getset |
The ETag of the item.
◆ Fingerprint
|
getset |
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.
◆ HealthChecks
|
getset |
The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified. Health check is optional for Compute Engine backend services if there is no backend. A health check must not be specified when adding Internet Network Endpoint Group or Serverless Network Endpoint Group as backends. In all other cases, a health check is required for Compute Engine backend services.
For internal load balancing, a URL to a HealthCheck resource must be specified instead.
◆ Id
|
getset |
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
◆ Kind
|
getset |
[Output Only] Type of resource. Always compute::backendService for backend services.
◆ LoadBalancingScheme
|
getset |
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.
◆ LocalityLbPolicy
|
getset |
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.
◆ LogConfig
|
getset |
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.
◆ Name
|
getset |
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.
◆ Network
|
getset |
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.
◆ OutlierDetection
|
getset |
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.
◆ Port
|
getset |
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).
◆ PortName
|
getset |
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 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 Blaancing).
◆ Protocol
|
getset |
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.
◆ Region
|
getset |
[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.
◆ SecurityPolicy
|
getset |
[Output Only] The resource URL for the security policy associated with this backend service.
◆ SelfLink
|
getset |
[Output Only] Server-defined URL for the resource.
◆ SessionAffinity
|
getset |
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.
◆ TimeoutSec
|
getset |
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.
The documentation for this class was generated from the following file:
- Google.Apis.Compute.v1.cs
