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
A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)
Instance Attribute Summary collapse
-
#affinity_cookie_ttl_sec ⇒ Fixnum
Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
-
#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.
-
#connection_draining ⇒ Google::Apis::ComputeBeta::ConnectionDraining
Message containing connection draining configuration.
-
#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, enable Cloud CDN for this BackendService.
-
#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
Indicates whether the backend service will be used with internal or external load balancing.
-
#name ⇒ String
Name of the resource.
-
#port ⇒ Fixnum
Deprecated in favor of portName.
-
#port_name ⇒ String
Name of backend port.
-
#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
How many seconds to wait for the backend before considering it a failed request.
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
2500 2501 2502 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2500 def initialize(**args) update!(**args) end |
Instance Attribute Details
#affinity_cookie_ttl_sec ⇒ Fixnum
Lifetime of cookies in seconds if session_affinity is GENERATED_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 for TTL is one day.
When the load balancing scheme is INTERNAL, this field is not used.
Corresponds to the JSON property affinityCookieTtlSec
2348 2349 2350 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2348 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
2353 2354 2355 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2353 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
2358 2359 2360 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2358 def cdn_policy @cdn_policy end |
#connection_draining ⇒ Google::Apis::ComputeBeta::ConnectionDraining
Message containing connection draining configuration.
Corresponds to the JSON property connectionDraining
2363 2364 2365 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2363 def connection_draining @connection_draining end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
2368 2369 2370 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2368 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
2373 2374 2375 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2373 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
2379 2380 2381 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2379 def description @description end |
#enable_cdn ⇒ Boolean Also known as: enable_cdn?
If true, enable Cloud CDN for this BackendService.
When the load balancing scheme is INTERNAL, this field is not used.
Corresponds to the JSON property enableCDN
2385 2386 2387 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2385 def enable_cdn @enable_cdn 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.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
2395 2396 2397 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2395 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
2406 2407 2408 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2406 def health_checks @health_checks end |
#iap ⇒ Google::Apis::ComputeBeta::BackendServiceIap
Identity-Aware Proxy
Corresponds to the JSON property iap
2411 2412 2413 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2411 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
2417 2418 2419 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2417 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
2423 2424 2425 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2423 def kind @kind end |
#load_balancing_scheme ⇒ String
Indicates whether the backend service will be used with internal or external
load balancing. A backend service created for one type of load balancing
cannot be used with the other. Possible values are INTERNAL and EXTERNAL.
Corresponds to the JSON property loadBalancingScheme
2430 2431 2432 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2430 def load_balancing_scheme @load_balancing_scheme 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
2440 2441 2442 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2440 def name @name 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 for internal load balancing.
Corresponds to the JSON property port
2447 2448 2449 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2447 def port @port end |
#port_name ⇒ String
Name of backend port. The same name should appear in the instance groups
referenced by this service. Required when the load balancing scheme is
EXTERNAL.
When the load balancing scheme is INTERNAL, this field is not used.
Corresponds to the JSON property portName
2455 2456 2457 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2455 def port_name @port_name end |
#protocol ⇒ String
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, TCP, and SSL. The default is HTTP.
For internal load balancing, the possible values are TCP and UDP, and the
default is TCP.
Corresponds to the JSON property protocol
2463 2464 2465 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2463 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
2471 2472 2473 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2471 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
2477 2478 2479 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2477 def security_policy @security_policy end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
2482 2483 2484 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2482 def self_link @self_link end |
#session_affinity ⇒ String
Type of session affinity to use. The default is NONE.
When the load balancing scheme is EXTERNAL, can be NONE, CLIENT_IP, or
GENERATED_COOKIE.
When the load balancing scheme is INTERNAL, can be NONE, CLIENT_IP,
CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
When the protocol is UDP, this field is not used.
Corresponds to the JSON property sessionAffinity
2492 2493 2494 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2492 def session_affinity @session_affinity end |
#timeout_sec ⇒ Fixnum
How many seconds to wait for the backend before considering it a failed
request. Default is 30 seconds.
Corresponds to the JSON property timeoutSec
2498 2499 2500 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2498 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 |
# File 'generated/google/apis/compute_beta/classes.rb', line 2505 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) @connection_draining = args[:connection_draining] if args.key?(:connection_draining) @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) @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) @name = args[:name] if args.key?(:name) @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 |