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
A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity.
Instance Attribute Summary collapse
-
#affinity_cookie_ttl_sec ⇒ Fixnum
Lifetime of cookies in seconds if session_affinity is GENERATED_COOKIE.
-
#backends ⇒ Array<Google::Apis::ComputeV1::Backend>
The list of backends that serve this BackendService.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#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.
-
#id ⇒ String
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of resource.
-
#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.
-
#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.
1148 1149 1150 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1148 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
1034 1035 1036 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1034 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
1039 1040 1041 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1039 def backends @backends end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
1044 1045 1046 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1044 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
1050 1051 1052 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1050 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
1056 1057 1058 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1056 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
1065 1066 1067 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1065 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 internal load balancing, a URL to a HealthCheck resource must be specified
instead.
Corresponds to the JSON property healthChecks
1074 1075 1076 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1074 def health_checks @health_checks end |
#id ⇒ String
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
1080 1081 1082 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1080 def id @id end |
#kind ⇒ String
[Output Only] Type of resource. Always compute#backendService for backend
services.
Corresponds to the JSON property kind
1086 1087 1088 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1086 def kind @kind 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? 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
1096 1097 1098 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1096 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
1103 1104 1105 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1103 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
1111 1112 1113 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1111 def port_name @port_name end |
#protocol ⇒ String
The protocol this BackendService uses to communicate with backends.
Possible values are HTTP, HTTPS, HTTP2, 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
1119 1120 1121 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1119 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.
Corresponds to the JSON property region
1125 1126 1127 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1125 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
1130 1131 1132 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1130 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
1140 1141 1142 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1140 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
1146 1147 1148 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1146 def timeout_sec @timeout_sec end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1153 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) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @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) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @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) @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 |