Class: Google::Apis::ComputeV1::BackendService

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

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. (== resource_for $api_version.backendService ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackendService

Returns a new instance of BackendService.



3033
3034
3035
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3033

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Lifetime of cookies in seconds. Only applicable if the loadBalancingScheme is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the protocol is HTTP or HTTPS, and the sessionAffinity is GENERATED_COOKIE, or HTTP_COOKIE. 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). 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. Corresponds to the JSON property affinityCookieTtlSec

Returns:

  • (Fixnum) 


2776
2777
2778
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2776

def affinity_cookie_ttl_sec
  @affinity_cookie_ttl_sec
end

#backends ⇒ Array<Google::Apis::ComputeV1::Backend>

The list of backends that serve this BackendService. Corresponds to the JSON property backends

Returns:



2781
2782
2783
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2781

def backends
  @backends
end

#cdn_policy ⇒ Google::Apis::ComputeV1::BackendServiceCdnPolicy

Message containing Cloud CDN configuration for a backend service. Corresponds to the JSON property cdnPolicy

Returns:



2786
2787
2788
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2786

def cdn_policy
  @cdn_policy
end

#circuit_breakers ⇒ Google::Apis::ComputeV1::CircuitBreakers

Settings controlling the volume of connections to a backend service. Corresponds to the JSON property circuitBreakers

Returns:



2791
2792
2793
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2791

def circuit_breakers
  @circuit_breakers
end

#connection_draining ⇒ Google::Apis::ComputeV1::ConnectionDraining

Message containing connection draining configuration. Corresponds to the JSON property connectionDraining

Returns:



2796
2797
2798
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2796

def connection_draining
  @connection_draining
end

#consistent_hash ⇒ Google::Apis::ComputeV1::ConsistentHashLoadBalancerSettings

This message defines settings for a consistent hash style load balancer. Corresponds to the JSON property consistentHash

Returns:



2801
2802
2803
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2801

def consistent_hash
  @consistent_hash
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


2806
2807
2808
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2806

def creation_timestamp
  @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

Returns:

  • (Array<String>) 


2811
2812
2813
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2811

def custom_request_headers
  @custom_request_headers
end

#custom_response_headers ⇒ Array<String>

Headers that the HTTP/S load balancer should add to proxied responses. Corresponds to the JSON property customResponseHeaders

Returns:

  • (Array<String>) 


2816
2817
2818
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2816

def custom_response_headers
  @custom_response_headers
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


2822
2823
2824
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2822

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

Returns:

  • (Boolean) 


2828
2829
2830
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2828

def enable_cdn
  @enable_cdn
end

#failover_policy ⇒ Google::Apis::ComputeV1::BackendServiceFailoverPolicy

Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). Corresponds to the JSON property failoverPolicy

Returns:



2841
2842
2843
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2841

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.

Returns:

  • (String) 


2853
2854
2855
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2853

def fingerprint
  @fingerprint
end

#health_checks ⇒ Array<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 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. Corresponds to the JSON property healthChecks

Returns:

  • (Array<String>) 


2864
2865
2866
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2864

def health_checks
  @health_checks
end

#iap ⇒ Google::Apis::ComputeV1::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



2869
2870
2871
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2869

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

Returns:

  • (Fixnum) 


2875
2876
2877
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2875

def id
  @id
end

#kind ⇒ String

[Output Only] Type of resource. Always compute#backendService for backend services. Corresponds to the JSON property kind

Returns:

  • (String) 


2881
2882
2883
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2881

def kind
  @kind
end

#load_balancing_scheme ⇒ String

Specifies the load balancer type. Choose EXTERNAL for external HTTP(S), SSL Proxy, TCP Proxy and Network Load Balancing. Choose INTERNAL for Internal TCP/ UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Corresponds to the JSON property loadBalancingScheme

Returns:

  • (String) 


2891
2892
2893
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2891

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, 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. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only the default ROUND_ROBIN policy is 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. Corresponds to the JSON property localityLbPolicy

Returns:

  • (String) 


2923
2924
2925
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2923

def locality_lb_policy
  @locality_lb_policy
end

#log_config ⇒ Google::Apis::ComputeV1::BackendServiceLogConfig

The available logging options for the load balancer traffic served by this backend service. Corresponds to the JSON property logConfig

Returns:



2929
2930
2931
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2929

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

Returns:

  • (String) 


2939
2940
2941
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2939

def name
  @name
end

#network ⇒ String

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. Corresponds to the JSON property network

Returns:

  • (String) 


2945
2946
2947
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2945

def network
  @network
end

#outlier_detection ⇒ Google::Apis::ComputeV1::OutlierDetection

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. Corresponds to the JSON property outlierDetection

Returns:



2951
2952
2953
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2951

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. Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


2959
2960
2961
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2959

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 (except Network Load Balancing), 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. Backend services for Internal TCP/UDP Load Balancing and Network Load Balancing require you omit port_name. Corresponds to the JSON property portName

Returns:

  • (String) 


2971
2972
2973
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2971

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, UDP or GRPC. 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. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Corresponds to the JSON property protocol

Returns:

  • (String) 


2982
2983
2984
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2982

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

Returns:

  • (String) 


2990
2991
2992
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2990

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

Returns:

  • (String) 


2996
2997
2998
 
# File 'lib/google/apis/compute_v1/classes.rb', line 2996

def security_policy
  @security_policy
end

#security_settings ⇒ Google::Apis::ComputeV1::SecuritySettings

The authentication and authorization settings for a BackendService. Corresponds to the JSON property securitySettings

Returns:



3001
3002
3003
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3001

def security_settings
  @security_settings
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


3006
3007
3008
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3006

def self_link
  @self_link
end

#session_affinity ⇒ String

Type of session affinity to use. The default is NONE. When the loadBalancingScheme is EXTERNAL: * For Network Load Balancing, the possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.

  • For all other load balancers that use loadBalancingScheme=EXTERNAL, the possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. * You can use GENERATED_COOKIE if the protocol is HTTP, HTTP2, 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. 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. Corresponds to the JSON property sessionAffinity

Returns:

  • (String) 


3023
3024
3025
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3023

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 see, Backend service settings The default is 30 seconds. The full range of timeout values allowed is 1 - 2,147,483,647 seconds. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum) 


3031
3032
3033
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3031

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'lib/google/apis/compute_v1/classes.rb', line 3038

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)
  @custom_response_headers = args[:custom_response_headers] if args.key?(:custom_response_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)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end