Class: Google::Apis::ComputeAlpha::BackendService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::BackendService
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1. backendService ==) (== resource_for beta.backendService ==)
Instance Attribute Summary collapse
-
#affinity_cookie_ttl_sec ⇒ Fixnum
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent).
-
#backends ⇒ Array<Google::Apis::ComputeAlpha::Backend>
The list of backends that serve this BackendService.
-
#cdn_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
-
#circuit_breakers ⇒ Google::Apis::ComputeAlpha::CircuitBreakers
Settings controlling the volume of connections to a backend service.
-
#connection_draining ⇒ Google::Apis::ComputeAlpha::ConnectionDraining
Message containing connection draining configuration.
-
#consistent_hash ⇒ Google::Apis::ComputeAlpha::ConsistentHashLoadBalancerSettings
This message defines settings for a consistent hash style load balancer.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#custom_request_headers ⇒ Array<String>
Headers that the HTTP/S load balancer should add to proxied requests.
-
#description ⇒ String
An optional description of this resource.
-
#enable_cdn ⇒ Boolean
(also: #enable_cdn?)
If true, enables Cloud CDN for the backend service.
-
#failover_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy
Applicable only to Failover for Internal TCP/UDP Load Balancing.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#health_checks ⇒ Array<String>
The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService.
-
#iap ⇒ Google::Apis::ComputeAlpha::BackendServiceIap
Identity-Aware Proxy Corresponds to the JSON property
iap
. -
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of resource.
-
#load_balancing_scheme ⇒ String
Indicates whether the backend service will be used with internal or external load balancing.
-
#locality_lb_policy ⇒ String
The load balancing algorithm used within the scope of the locality.
-
#log_config ⇒ Google::Apis::ComputeAlpha::BackendServiceLogConfig
The available logging options for the load balancer traffic served by this backend service.
-
#name ⇒ String
Name of the resource.
-
#network ⇒ String
The URL of the network to which this backend service belongs.
-
#outlier_detection ⇒ Google::Apis::ComputeAlpha::OutlierDetection
Settings controlling eviction of unhealthy hosts from the load balancing pool.
-
#port ⇒ Fixnum
Deprecated in favor of portName.
-
#port_name ⇒ String
A named port on a backend instance group representing the port for communication to the backend VMs in that group.
-
#protocol ⇒ String
The protocol this BackendService uses to communicate with backends.
-
#region ⇒ String
[Output Only] URL of the region where the regional backend service resides.
-
#security_policy ⇒ String
[Output Only] The resource URL for the security policy associated with this backend service.
-
#security_settings ⇒ Google::Apis::ComputeAlpha::SecuritySettings
The authentication and authorization settings for a BackendService.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#session_affinity ⇒ String
Type of session affinity to use.
-
#timeout_sec ⇒ Fixnum
The backend service timeout has a different meaning depending on the type of load balancer.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BackendService
constructor
A new instance of BackendService.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ BackendService
Returns a new instance of BackendService
3078 3079 3080 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3078 def initialize(**args) update!(**args) end |
Instance Attribute Details
#affinity_cookie_ttl_sec ⇒ Fixnum
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).
Corresponds to the JSON property affinityCookieTtlSec
2845 2846 2847 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2845 def @affinity_cookie_ttl_sec end |
#backends ⇒ Array<Google::Apis::ComputeAlpha::Backend>
The list of backends that serve this BackendService.
Corresponds to the JSON property backends
2850 2851 2852 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2850 def backends @backends end |
#cdn_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
Corresponds to the JSON property cdnPolicy
2855 2856 2857 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2855 def cdn_policy @cdn_policy end |
#circuit_breakers ⇒ Google::Apis::ComputeAlpha::CircuitBreakers
Settings controlling the volume of connections to a backend service.
Corresponds to the JSON property circuitBreakers
2860 2861 2862 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2860 def circuit_breakers @circuit_breakers end |
#connection_draining ⇒ Google::Apis::ComputeAlpha::ConnectionDraining
Message containing connection draining configuration.
Corresponds to the JSON property connectionDraining
2865 2866 2867 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2865 def connection_draining @connection_draining end |
#consistent_hash ⇒ Google::Apis::ComputeAlpha::ConsistentHashLoadBalancerSettings
This message defines settings for a consistent hash style load balancer.
Corresponds to the JSON property consistentHash
2870 2871 2872 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2870 def consistent_hash @consistent_hash end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
2875 2876 2877 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2875 def @creation_timestamp end |
#custom_request_headers ⇒ Array<String>
Headers that the HTTP/S load balancer should add to proxied requests.
Corresponds to the JSON property customRequestHeaders
2880 2881 2882 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2880 def custom_request_headers @custom_request_headers end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
2886 2887 2888 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2886 def description @description end |
#enable_cdn ⇒ Boolean Also known as: enable_cdn?
If true, enables Cloud CDN for the backend service. Only applicable if the
loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
Corresponds to the JSON property enableCDN
2892 2893 2894 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2892 def enable_cdn @enable_cdn end |
#failover_policy ⇒ Google::Apis::ComputeAlpha::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.
Corresponds to the JSON property failoverPolicy
2899 2900 2901 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2899 def failover_policy @failover_policy end |
#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.
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.
2911 2912 2913 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2911 def fingerprint @fingerprint end |
#health_checks ⇒ Array<String>
The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for
health checking this BackendService. Currently at most one health check can be
specified, and a health check is required for Compute Engine backend services.
A health check must not be specified for App Engine backend and Cloud Function
backend.
For internal load balancing, a URL to a HealthCheck resource must be specified
instead.
Corresponds to the JSON property healthChecks
2922 2923 2924 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2922 def health_checks @health_checks end |
#iap ⇒ Google::Apis::ComputeAlpha::BackendServiceIap
Identity-Aware Proxy
Corresponds to the JSON property iap
2927 2928 2929 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2927 def iap @iap end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
2933 2934 2935 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2933 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
2939 2940 2941 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2939 def kind @kind end |
#load_balancing_scheme ⇒ String
Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing
cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
Corresponds to the JSON property loadBalancingScheme
2946 2947 2948 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2946 def load_balancing_scheme @load_balancing_scheme end |
#locality_lb_policy ⇒ String
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.
Corresponds to the JSON property
localityLbPolicy
2973 2974 2975 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2973 def locality_lb_policy @locality_lb_policy end |
#log_config ⇒ Google::Apis::ComputeAlpha::BackendServiceLogConfig
The available logging options for the load balancer traffic served by this
backend service.
Corresponds to the JSON property logConfig
2979 2980 2981 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2979 def log_config @log_config end |
#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.
Corresponds to the JSON property name
2989 2990 2991 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2989 def name @name end |
#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.
Corresponds to the JSON property network
2995 2996 2997 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2995 def network @network end |
#outlier_detection ⇒ Google::Apis::ComputeAlpha::OutlierDetection
Settings controlling eviction of unhealthy hosts from the load balancing pool.
Corresponds to the JSON property outlierDetection
3000 3001 3002 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3000 def outlier_detection @outlier_detection end |
#port ⇒ Fixnum
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).
Corresponds to the JSON property port
3008 3009 3010 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3008 def port @port end |
#port_name ⇒ 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 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).
Corresponds to the JSON property portName
3019 3020 3021 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3019 def port_name @port_name end |
#protocol ⇒ String
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, 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.
Corresponds to the JSON property protocol
3027 3028 3029 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3027 def protocol @protocol end |
#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.
Corresponds to the JSON property region
3035 3036 3037 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3035 def region @region end |
#security_policy ⇒ String
[Output Only] The resource URL for the security policy associated with this
backend service.
Corresponds to the JSON property securityPolicy
3041 3042 3043 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3041 def security_policy @security_policy end |
#security_settings ⇒ Google::Apis::ComputeAlpha::SecuritySettings
The authentication and authorization settings for a BackendService.
Corresponds to the JSON property securitySettings
3046 3047 3048 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3046 def security_settings @security_settings end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
3051 3052 3053 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3051 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
3056 3057 3058 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3056 def self_link_with_id @self_link_with_id end |
#session_affinity ⇒ String
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. GENERATED_COOKIE is only available 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, possible values are
NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.
Corresponds to the JSON property sessionAffinity
3069 3070 3071 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3069 def session_affinity @session_affinity end |
#timeout_sec ⇒ Fixnum
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.
Corresponds to the JSON property timeoutSec
3076 3077 3078 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3076 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 3083 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) @connection_draining = args[:connection_draining] if args.key?(:connection_draining) @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) @description = args[:description] if args.key?(:description) @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_policy = args[:locality_lb_policy] if args.key?(:locality_lb_policy) @log_config = args[:log_config] if args.key?(:log_config) @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) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) end |