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

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.


3418
3419
3420
# File 'generated/google/apis/compute_alpha/classes.rb', line 3418

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)

3167
3168
3169
# File 'generated/google/apis/compute_alpha/classes.rb', line 3167

def affinity_cookie_ttl_sec
  @affinity_cookie_ttl_sec
end

#backendsArray<Google::Apis::ComputeAlpha::Backend>

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


3172
3173
3174
# File 'generated/google/apis/compute_alpha/classes.rb', line 3172

def backends
  @backends
end

#cdn_policyGoogle::Apis::ComputeAlpha::BackendServiceCdnPolicy

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


3177
3178
3179
# File 'generated/google/apis/compute_alpha/classes.rb', line 3177

def cdn_policy
  @cdn_policy
end

#circuit_breakersGoogle::Apis::ComputeAlpha::CircuitBreakers

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


3182
3183
3184
# File 'generated/google/apis/compute_alpha/classes.rb', line 3182

def circuit_breakers
  @circuit_breakers
end

#connection_drainingGoogle::Apis::ComputeAlpha::ConnectionDraining

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


3187
3188
3189
# File 'generated/google/apis/compute_alpha/classes.rb', line 3187

def connection_draining
  @connection_draining
end

#consistent_hashGoogle::Apis::ComputeAlpha::ConsistentHashLoadBalancerSettings

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


3192
3193
3194
# File 'generated/google/apis/compute_alpha/classes.rb', line 3192

def consistent_hash
  @consistent_hash
end

#creation_timestampString

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

Returns:

  • (String)

3197
3198
3199
# File 'generated/google/apis/compute_alpha/classes.rb', line 3197

def creation_timestamp
  @creation_timestamp
end

#custom_request_headersArray<String>

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

Returns:

  • (Array<String>)

3202
3203
3204
# File 'generated/google/apis/compute_alpha/classes.rb', line 3202

def custom_request_headers
  @custom_request_headers
end

#custom_response_headersArray<String>

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

Returns:

  • (Array<String>)

3207
3208
3209
# File 'generated/google/apis/compute_alpha/classes.rb', line 3207

def custom_response_headers
  @custom_response_headers
end

#descriptionString

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

Returns:

  • (String)

3213
3214
3215
# File 'generated/google/apis/compute_alpha/classes.rb', line 3213

def description
  @description
end

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

3219
3220
3221
# File 'generated/google/apis/compute_alpha/classes.rb', line 3219

def enable_cdn
  @enable_cdn
end

#failover_policyGoogle::Apis::ComputeAlpha::BackendServiceFailoverPolicy

Applicable only to Failover for Internal TCP/UDP 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


3231
3232
3233
# File 'generated/google/apis/compute_alpha/classes.rb', line 3231

def failover_policy
  @failover_policy
end

#fingerprintString

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)

3243
3244
3245
# File 'generated/google/apis/compute_alpha/classes.rb', line 3243

def fingerprint
  @fingerprint
end

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

3254
3255
3256
# File 'generated/google/apis/compute_alpha/classes.rb', line 3254

def health_checks
  @health_checks
end

#iapGoogle::Apis::ComputeAlpha::BackendServiceIap

Identity-Aware Proxy Corresponds to the JSON property iap


3259
3260
3261
# File 'generated/google/apis/compute_alpha/classes.rb', line 3259

def iap
  @iap
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)

3265
3266
3267
# File 'generated/google/apis/compute_alpha/classes.rb', line 3265

def id
  @id
end

#kindString

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

Returns:

  • (String)

3271
3272
3273
# File 'generated/google/apis/compute_alpha/classes.rb', line 3271

def kind
  @kind
end

#load_balancing_schemeString

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)

3281
3282
3283
# File 'generated/google/apis/compute_alpha/classes.rb', line 3281

def load_balancing_scheme
  @load_balancing_scheme
end

#locality_lb_policyString

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

Returns:

  • (String)

3310
3311
3312
# File 'generated/google/apis/compute_alpha/classes.rb', line 3310

def locality_lb_policy
  @locality_lb_policy
end

#log_configGoogle::Apis::ComputeAlpha::BackendServiceLogConfig

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


3316
3317
3318
# File 'generated/google/apis/compute_alpha/classes.rb', line 3316

def log_config
  @log_config
end

#nameString

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)

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

def name
  @name
end

#networkString

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)

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

def network
  @network
end

#outlier_detectionGoogle::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


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

def outlier_detection
  @outlier_detection
end

#portFixnum

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)

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

def port
  @port
end

#port_nameString

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, 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. Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing). Corresponds to the JSON property portName

Returns:

  • (String)

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

def port_name
  @port_name
end

#protocolString

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

Returns:

  • (String)

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

def protocol
  @protocol
end

#regionString

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

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

def region
  @region
end

#security_policyString

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

Returns:

  • (String)

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

def security_policy
  @security_policy
end

#security_settingsGoogle::Apis::ComputeAlpha::SecuritySettings

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


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

def security_settings
  @security_settings
end

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

Returns:

  • (String)

3390
3391
3392
# File 'generated/google/apis/compute_alpha/classes.rb', line 3390

def self_link
  @self_link
end

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String)

3395
3396
3397
# File 'generated/google/apis/compute_alpha/classes.rb', line 3395

def self_link_with_id
  @self_link_with_id
end

#session_affinityString

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

Returns:

  • (String)

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

def session_affinity
  @session_affinity
end

#timeout_secFixnum

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)

3416
3417
3418
# File 'generated/google/apis/compute_alpha/classes.rb', line 3416

def timeout_sec
  @timeout_sec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
# File 'generated/google/apis/compute_alpha/classes.rb', line 3423

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