Class: Google::Apis::ComputeAlpha::BackendService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::BackendService
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/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.
-
#app_engine_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend
Configuration of a App Engine backend.
-
#backends ⇒ Array<Google::Apis::ComputeAlpha::Backend>
The list of backends that serve this BackendService.
-
#cdn_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
-
#cloud_function_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend
Configuration of a Cloud Function backend.
-
#connection_draining ⇒ Google::Apis::ComputeAlpha::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.
-
#failover_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy
Corresponds to the JSON property
failoverPolicy
. -
#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::ComputeAlpha::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
2655 2656 2657 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2655 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
2488 2489 2490 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2488 def @affinity_cookie_ttl_sec end |
#app_engine_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceAppEngineBackend
Configuration of a App Engine backend.
Corresponds to the JSON property appEngineBackend
2493 2494 2495 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2493 def app_engine_backend @app_engine_backend end |
#backends ⇒ Array<Google::Apis::ComputeAlpha::Backend>
The list of backends that serve this BackendService.
Corresponds to the JSON property backends
2498 2499 2500 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2498 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
2503 2504 2505 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2503 def cdn_policy @cdn_policy end |
#cloud_function_backend ⇒ Google::Apis::ComputeAlpha::BackendServiceCloudFunctionBackend
Configuration of a Cloud Function backend.
Corresponds to the JSON property cloudFunctionBackend
2508 2509 2510 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2508 def cloud_function_backend @cloud_function_backend end |
#connection_draining ⇒ Google::Apis::ComputeAlpha::ConnectionDraining
Message containing connection draining configuration.
Corresponds to the JSON property connectionDraining
2513 2514 2515 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2513 def connection_draining @connection_draining end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
2518 2519 2520 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2518 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
2523 2524 2525 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2523 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
2529 2530 2531 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2529 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
2535 2536 2537 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2535 def enable_cdn @enable_cdn end |
#failover_policy ⇒ Google::Apis::ComputeAlpha::BackendServiceFailoverPolicy
Corresponds to the JSON property failoverPolicy
2541 2542 2543 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2541 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.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
2550 2551 2552 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2550 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
2561 2562 2563 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2561 def health_checks @health_checks end |
#iap ⇒ Google::Apis::ComputeAlpha::BackendServiceIap
Identity-Aware Proxy
Corresponds to the JSON property iap
2566 2567 2568 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2566 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
2572 2573 2574 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2572 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
2578 2579 2580 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2578 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
2585 2586 2587 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2585 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
2595 2596 2597 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2595 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
2602 2603 2604 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2602 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
2610 2611 2612 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2610 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
2618 2619 2620 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2618 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
2626 2627 2628 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2626 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
2632 2633 2634 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2632 def security_policy @security_policy end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
2637 2638 2639 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2637 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
2647 2648 2649 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2647 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
2653 2654 2655 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2653 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 2660 def update!(**args) @affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec) @app_engine_backend = args[:app_engine_backend] if args.key?(:app_engine_backend) @backends = args[:backends] if args.key?(:backends) @cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy) @cloud_function_backend = args[:cloud_function_backend] if args.key?(:cloud_function_backend) @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) @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) @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 |