Class: Google::Apis::ComputeV1::BackendService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::BackendService
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb
Overview
Represents a Backend Service resource. Backend services must have an associated health check. Backend services also store information about session affinity. For more information, read Backend Services. A backendServices resource represents a global backend service. Global backend services are used for HTTP(S), SSL Proxy, TCP Proxy load balancing and Traffic Director. A regionBackendServices resource represents a regional backend service. Regional backend services are used for internal TCP/UDP load balancing. For more information, read Internal TCP/UDP Load balancing. (== resource_for v1. backendService ==) (== resource_for beta.backendService ==)
Instance Attribute Summary collapse
-
#affinity_cookie_ttl_sec ⇒ Fixnum
If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent).
-
#backends ⇒ Array<Google::Apis::ComputeV1::Backend>
The list of backends that serve this BackendService.
-
#cdn_policy ⇒ Google::Apis::ComputeV1::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
-
#connection_draining ⇒ Google::Apis::ComputeV1::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, enables Cloud CDN for the backend service.
-
#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::ComputeV1::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
A named port on a backend instance group representing the port for communication to the backend VMs in that group.
-
#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
The backend service timeout has a different meaning depending on the type of load balancer.
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
2657 2658 2659 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2657 def initialize(**args) update!(**args) end |
Instance Attribute Details
#affinity_cookie_ttl_sec ⇒ Fixnum
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
2494 2495 2496 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2494 def @affinity_cookie_ttl_sec end |
#backends ⇒ Array<Google::Apis::ComputeV1::Backend>
The list of backends that serve this BackendService.
Corresponds to the JSON property backends
2499 2500 2501 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2499 def backends @backends end |
#cdn_policy ⇒ Google::Apis::ComputeV1::BackendServiceCdnPolicy
Message containing Cloud CDN configuration for a backend service.
Corresponds to the JSON property cdnPolicy
2504 2505 2506 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2504 def cdn_policy @cdn_policy end |
#connection_draining ⇒ Google::Apis::ComputeV1::ConnectionDraining
Message containing connection draining configuration.
Corresponds to the JSON property connectionDraining
2509 2510 2511 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2509 def connection_draining @connection_draining end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
2514 2515 2516 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2514 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
2519 2520 2521 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2519 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
2525 2526 2527 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2525 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
2531 2532 2533 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2531 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, 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.
2544 2545 2546 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2544 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
2555 2556 2557 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2555 def health_checks @health_checks end |
#iap ⇒ Google::Apis::ComputeV1::BackendServiceIap
Identity-Aware Proxy
Corresponds to the JSON property iap
2560 2561 2562 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2560 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
2566 2567 2568 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2566 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
2572 2573 2574 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2572 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
2579 2580 2581 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2579 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
2589 2590 2591 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2589 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 if the loadBalancingScheme is INTERNAL (Internal TCP/UDP
Load Balancing).
Corresponds to the JSON property port
2597 2598 2599 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2597 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
2608 2609 2610 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2608 def port_name @port_name end |
#protocol ⇒ String
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, 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
2616 2617 2618 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2616 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
2624 2625 2626 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2624 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
2630 2631 2632 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2630 def security_policy @security_policy end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
2635 2636 2637 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2635 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. GENERATED_COOKIE is only available 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
2648 2649 2650 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2648 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
2655 2656 2657 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2655 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
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 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2662 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 |