Class: Google::Apis::ComputeAlpha::HttpsHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HttpsHealthCheck
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents a legacy HTTPS Health Check resource. Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks. For more information, see Health checks overview .
Instance Attribute Summary collapse
-
#check_interval_sec ⇒ Fixnum
How often (in seconds) to send a health check.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#healthy_threshold ⇒ Fixnum
A so-far unhealthy instance will be marked healthy after this many consecutive successes.
-
#host ⇒ String
The value of the host header in the HTTPS health check request.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#port ⇒ Fixnum
The TCP port number for the HTTPS health check request.
-
#port_name ⇒ String
Port name as defined in InstanceGroup#NamedPort#name.
-
#port_specification ⇒ String
Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking.
-
#proxy_header ⇒ String
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
-
#request_path ⇒ String
The request path of the HTTPS health check request.
-
#response ⇒ String
The string to match anywhere in the first 1024 bytes of the response body.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#timeout_sec ⇒ Fixnum
How long (in seconds) to wait before claiming failure.
-
#unhealthy_threshold ⇒ Fixnum
A so-far healthy instance will be marked unhealthy after this many consecutive failures.
-
#weight_report_mode ⇒ String
Weight report mode.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpsHealthCheck
constructor
A new instance of HttpsHealthCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ HttpsHealthCheck
Returns a new instance of HttpsHealthCheck.
11311 11312 11313 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11311 def initialize(**args) update!(**args) end |
Instance Attribute Details
#check_interval_sec ⇒ Fixnum
How often (in seconds) to send a health check. The default value is 5 seconds.
Corresponds to the JSON property checkIntervalSec
13517 13518 13519 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13517 def check_interval_sec @check_interval_sec end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
13522 13523 13524 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13522 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
13528 13529 13530 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13528 def description @description end |
#healthy_threshold ⇒ Fixnum
A so-far unhealthy instance will be marked healthy after this many consecutive
successes. The default value is 2.
Corresponds to the JSON property healthyThreshold
13534 13535 13536 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13534 def healthy_threshold @healthy_threshold end |
#host ⇒ String
The value of the host header in the HTTPS health check request. If left empty (
default value), the public IP on behalf of which this health check is
performed will be used.
Corresponds to the JSON property host
11263 11264 11265 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11263 def host @host end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
13547 13548 13549 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13547 def id @id end |
#kind ⇒ String
Type of the resource.
Corresponds to the JSON property kind
13552 13553 13554 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13552 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]([-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
13562 13563 13564 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13562 def name @name end |
#port ⇒ Fixnum
The TCP port number for the HTTPS health check request. The default value is
443.
Corresponds to the JSON property port
11269 11270 11271 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11269 def port @port end |
#port_name ⇒ String
Port name as defined in InstanceGroup#NamedPort#name. If both port and
port_name are defined, port takes precedence.
Corresponds to the JSON property portName
11275 11276 11277 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11275 def port_name @port_name end |
#port_specification ⇒ String
Specifies how port is selected for health checking, can be one of following
values: USE_FIXED_PORT: The port number in port is used for health checking.
USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT:
For NetworkEndpointGroup, the port specified for each network endpoint is used
for health checking. For other backends, the port or named port specified in
the Backend Service is used for health checking. If not specified, HTTPS
health check follows behavior specified in port and portName fields.
Corresponds to the JSON property portSpecification
11286 11287 11288 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11286 def port_specification @port_specification end |
#proxy_header ⇒ String
Specifies the type of proxy header to append before sending data to the
backend, either NONE or PROXY_V1. The default is NONE.
Corresponds to the JSON property proxyHeader
11292 11293 11294 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11292 def proxy_header @proxy_header end |
#request_path ⇒ String
The request path of the HTTPS health check request. The default value is "/".
Corresponds to the JSON property requestPath
11297 11298 11299 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11297 def request_path @request_path end |
#response ⇒ String
The string to match anywhere in the first 1024 bytes of the response body. If
left empty (the default value), the status code determines health. The
response data can only be ASCII.
Corresponds to the JSON property response
11304 11305 11306 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11304 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13578 13579 13580 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13578 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
13583 13584 13585 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13583 def self_link_with_id @self_link_with_id end |
#timeout_sec ⇒ Fixnum
How long (in seconds) to wait before claiming failure. The default value is 5
seconds. It is invalid for timeoutSec to have a greater value than
checkIntervalSec.
Corresponds to the JSON property timeoutSec
13590 13591 13592 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13590 def timeout_sec @timeout_sec end |
#unhealthy_threshold ⇒ Fixnum
A so-far healthy instance will be marked unhealthy after this many consecutive
failures. The default value is 2.
Corresponds to the JSON property unhealthyThreshold
13596 13597 13598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13596 def unhealthy_threshold @unhealthy_threshold end |
#weight_report_mode ⇒ String
Weight report mode. used for weighted Load Balancing.
Corresponds to the JSON property weightReportMode
11309 11310 11311 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11309 def weight_report_mode @weight_report_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11316 def update!(**args) @host = args[:host] if args.key?(:host) @port = args[:port] if args.key?(:port) @port_name = args[:port_name] if args.key?(:port_name) @port_specification = args[:port_specification] if args.key?(:port_specification) @proxy_header = args[:proxy_header] if args.key?(:proxy_header) @request_path = args[:request_path] if args.key?(:request_path) @response = args[:response] if args.key?(:response) @weight_report_mode = args[:weight_report_mode] if args.key?(:weight_report_mode) end |