Class: Google::Apis::ComputeBeta::BackendService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::BackendService
- Defined in:
- generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/representations.rb
Overview
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.
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::ComputeBeta::Backend>
The list of backends that serve this BackendService.
-
#cdn_policy ⇒ Google::Apis::ComputeBeta::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
-
#circuit_breakers ⇒ Google::Apis::ComputeBeta::CircuitBreakers
Settings controlling the volume of connections to a backend service.
-
#connection_draining ⇒ Google::Apis::ComputeBeta::ConnectionDraining
Message containing connection draining configuration.
-
#consistent_hash ⇒ Google::Apis::ComputeBeta::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::ComputeBeta::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::ComputeBeta::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
Specifies the load balancer type.
-
#locality_lb_policy ⇒ String
The load balancing algorithm used within the scope of the locality.
-
#log_config ⇒ Google::Apis::ComputeBeta::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::ComputeBeta::OutlierDetection
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
-
#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.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#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.
2956 2957 2958 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2956 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
2723 2724 2725 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2723 def @affinity_cookie_ttl_sec end |
#backends ⇒ Array<Google::Apis::ComputeBeta::Backend>
The list of backends that serve this BackendService.
Corresponds to the JSON property backends
2728 2729 2730 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2728 def backends @backends end |
#cdn_policy ⇒ Google::Apis::ComputeBeta::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
Corresponds to the JSON property cdnPolicy
2733 2734 2735 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2733 def cdn_policy @cdn_policy end |
#circuit_breakers ⇒ Google::Apis::ComputeBeta::CircuitBreakers
Settings controlling the volume of connections to a backend service.
Corresponds to the JSON property circuitBreakers
2738 2739 2740 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2738 def circuit_breakers @circuit_breakers end |
#connection_draining ⇒ Google::Apis::ComputeBeta::ConnectionDraining
Message containing connection draining configuration.
Corresponds to the JSON property connectionDraining
2743 2744 2745 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2743 def connection_draining @connection_draining end |
#consistent_hash ⇒ Google::Apis::ComputeBeta::ConsistentHashLoadBalancerSettings
This message defines settings for a consistent hash style load balancer.
Corresponds to the JSON property consistentHash
2748 2749 2750 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2748 def consistent_hash @consistent_hash end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
2753 2754 2755 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2753 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
2758 2759 2760 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2758 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
2764 2765 2766 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2764 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
2770 2771 2772 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2770 def enable_cdn @enable_cdn end |
#failover_policy ⇒ Google::Apis::ComputeBeta::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
2777 2778 2779 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2777 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.
2789 2790 2791 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2789 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. 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.
Corresponds to the JSON property healthChecks
2802 2803 2804 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2802 def health_checks @health_checks end |
#iap ⇒ Google::Apis::ComputeBeta::BackendServiceIap
Identity-Aware Proxy
Corresponds to the JSON property iap
2807 2808 2809 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2807 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
2813 2814 2815 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2813 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
2819 2820 2821 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2819 def kind @kind end |
#load_balancing_scheme ⇒ 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.
Corresponds to the JSON property loadBalancingScheme
2829 2830 2831 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2829 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.
If sessionAffinity is not NONE, and this field is not set to >MAGLEV or
RING_HASH, session affinity settings will not take effect.
Corresponds to the JSON property
localityLbPolicy
2858 2859 2860 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2858 def locality_lb_policy @locality_lb_policy end |
#log_config ⇒ Google::Apis::ComputeBeta::BackendServiceLogConfig
The available logging options for the load balancer traffic served by this
backend service.
Corresponds to the JSON property logConfig
2864 2865 2866 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2864 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
2874 2875 2876 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2874 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
2880 2881 2882 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2880 def network @network end |
#outlier_detection ⇒ Google::Apis::ComputeBeta::OutlierDetection
Settings controlling the eviction of unhealthy hosts from the load balancing
pool for the backend service.
Corresponds to the JSON property outlierDetection
2886 2887 2888 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2886 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
2894 2895 2896 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2894 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
2905 2906 2907 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2905 def port_name @port_name end |
#protocol ⇒ String
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.
Corresponds to the JSON property protocol
2914 2915 2916 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2914 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
2922 2923 2924 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2922 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
2928 2929 2930 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2928 def security_policy @security_policy end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
2933 2934 2935 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2933 def self_link @self_link 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. 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.
Corresponds to the JSON property sessionAffinity
2947 2948 2949 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2947 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
2954 2955 2956 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2954 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2961 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) @self_link = args[:self_link] if args.key?(:self_link) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) end |