Class: Google::Apis::ComputeBeta::BackendService

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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. For more information, read Backend Services. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BackendService

Returns a new instance of BackendService



2829
2830
2831
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2829

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

Instance Attribute Details

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

Returns:

  • (Fixnum) 


2601
2602
2603
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2601

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

Returns:



2606
2607
2608
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2606

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

Returns:



2611
2612
2613
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2611

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

Returns:



2616
2617
2618
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2616

def circuit_breakers
  @circuit_breakers
end

#connection_draining ⇒ Google::Apis::ComputeBeta::ConnectionDraining

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

Returns:



2621
2622
2623
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2621

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

Returns:



2626
2627
2628
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2626

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) 


2631
2632
2633
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2631

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


2636
2637
2638
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2636

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

Returns:

  • (String) 


2642
2643
2644
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2642

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) 


2648
2649
2650
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2648

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

Returns:



2655
2656
2657
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2655

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) 


2667
2668
2669
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2667

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

Returns:

  • (Array<String>) 


2678
2679
2680
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2678

def health_checks
  @health_checks
end

#iap ⇒ Google::Apis::ComputeBeta::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



2683
2684
2685
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2683

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) 


2689
2690
2691
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2689

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) 


2695
2696
2697
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2695

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

Returns:

  • (String) 


2705
2706
2707
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2705

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

Returns:

  • (String) 


2732
2733
2734
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2732

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

Returns:



2738
2739
2740
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2738

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) 


2748
2749
2750
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2748

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

Returns:

  • (String) 


2754
2755
2756
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2754

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

Returns:



2760
2761
2762
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2760

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

Returns:

  • (Fixnum) 


2768
2769
2770
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2768

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

Returns:

  • (String) 


2779
2780
2781
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2779

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

Returns:

  • (String) 


2788
2789
2790
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2788

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) 


2796
2797
2798
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2796

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) 


2802
2803
2804
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2802

def security_policy
  @security_policy
end

#self_link ⇒ String

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

Returns:

  • (String) 


2807
2808
2809
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2807

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, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE. Corresponds to the JSON property sessionAffinity

Returns:

  • (String) 


2820
2821
2822
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2820

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

Returns:

  • (Fixnum) 


2827
2828
2829
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2827

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
 
# File 'generated/google/apis/compute_beta/classes.rb', line 2834

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