Class: Google::Apis::ComputeAlpha::BackendService

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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. 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.



3599
3600
3601
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3599

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) 


3322
3323
3324
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3322

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

Returns:



3327
3328
3329
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3327

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

Returns:



3332
3333
3334
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3332

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

Returns:



3337
3338
3339
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3337

def circuit_breakers
  @circuit_breakers
end

#connection_draining ⇒ Google::Apis::ComputeAlpha::ConnectionDraining

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

Returns:



3342
3343
3344
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3342

def connection_draining
  @connection_draining
end

#connection_tracking_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceConnectionTrackingPolicy

Connection Tracking configuration for this BackendService. Corresponds to the JSON property connectionTrackingPolicy

Returns:



3347
3348
3349
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3347

def connection_tracking_policy
  @connection_tracking_policy
end

#consistent_hash ⇒ Google::Apis::ComputeAlpha::ConsistentHashLoadBalancerSettings

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

Returns:



3352
3353
3354
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3352

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) 


3357
3358
3359
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3357

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


3362
3363
3364
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3362

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


3367
3368
3369
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3367

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) 


3373
3374
3375
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3373

def description
  @description
end

#edge_security_policy ⇒ String

[Output Only] The resource URL for the edge security policy associated with this backend service. Corresponds to the JSON property edgeSecurityPolicy

Returns:

  • (String) 


3379
3380
3381
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3379

def edge_security_policy
  @edge_security_policy
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) 


3385
3386
3387
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3385

def enable_cdn
  @enable_cdn
end

#failover_policy ⇒ Google::Apis::ComputeAlpha::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:



3398
3399
3400
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3398

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) 


3410
3411
3412
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3410

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


3421
3422
3423
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3421

def health_checks
  @health_checks
end

#iap ⇒ Google::Apis::ComputeAlpha::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap

Returns:



3426
3427
3428
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3426

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) 


3432
3433
3434
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3432

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) 


3438
3439
3440
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3438

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) 


3448
3449
3450
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3448

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) 


3480
3481
3482
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3480

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

Returns:



3486
3487
3488
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3486

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) 


3496
3497
3498
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3496

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) 


3502
3503
3504
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3502

def network
  @network
end

#outlier_detection ⇒ Google::Apis::ComputeAlpha::OutlierDetection

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

Returns:



3508
3509
3510
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3508

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) 


3516
3517
3518
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3516

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) 


3528
3529
3530
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3528

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) 


3539
3540
3541
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3539

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) 


3547
3548
3549
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3547

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) 


3553
3554
3555
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3553

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

Returns:



3558
3559
3560
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3558

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) 


3563
3564
3565
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3563

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

Returns:

  • (String) 


3568
3569
3570
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3568

def self_link_with_id
  @self_link_with_id
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) 


3585
3586
3587
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3585

def session_affinity
  @session_affinity
end

#subsetting ⇒ Google::Apis::ComputeAlpha::Subsetting

Subsetting options to make L4 ILB support any number of backend instances Corresponds to the JSON property subsetting

Returns:



3590
3591
3592
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3590

def subsetting
  @subsetting
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. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum) 


3597
3598
3599
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3597

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3604

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)
  @connection_tracking_policy = args[:connection_tracking_policy] if args.key?(:connection_tracking_policy)
  @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)
  @edge_security_policy = args[:edge_security_policy] if args.key?(:edge_security_policy)
  @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)
  @subsetting = args[:subsetting] if args.key?(:subsetting)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end