Class: Google::Apis::ComputeV1::HttpsHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::HttpsHealthCheck
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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
Not supported.
-
#port_specification ⇒ String
Specifies how a port is selected 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
Creates a content-based HTTPS health check.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#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.
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.
11115 11116 11117 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11115 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
13116 13117 13118 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13116 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
13121 13122 13123 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13121 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
13127 13128 13129 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13127 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
13133 13134 13135 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13133 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
11059 11060 11061 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11059 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
13146 13147 13148 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13146 def id @id end |
#kind ⇒ String
Type of the resource.
Corresponds to the JSON property kind
13151 13152 13153 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13151 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
13161 13162 13163 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13161 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
11065 11066 11067 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11065 def port @port end |
#port_name ⇒ String
Not supported.
Corresponds to the JSON property portName
11070 11071 11072 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11070 def port_name @port_name end |
#port_specification ⇒ String
Specifies how a port is selected for health checking. Can be one of the
following values: USE_FIXED_PORT: Specifies a port number explicitly using the
port field in the health check. Supported by backend services for passthrough
load balancers and backend services for proxy load balancers. Not supported by
target pools. The health check supports all backends supported by the backend
service provided the backend can be health checked. For example, GCE_VM_IP
network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance
group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an
indirect method of specifying the health check port by referring to the
backend service. Only supported by backend services for proxy load balancers.
Not supported by target pools. Not supported by backend services for
passthrough load balancers. Supports all backends that can be health checked;
for example, GCE_VM_IP_PORT network endpoint groups and instance group
backends. For GCE_VM_IP_PORT network endpoint group backends, the health check
uses the port number specified for each endpoint in the network endpoint group.
For instance group backends, the health check uses the port number determined
by looking up the backend service's named port in the instance group's list of
named ports.
Corresponds to the JSON property portSpecification
11092 11093 11094 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11092 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
11098 11099 11100 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11098 def proxy_header @proxy_header end |
#request_path ⇒ String
The request path of the HTTPS health check request. The default value is "/".
Must comply with RFC3986.
Corresponds to the JSON property requestPath
11104 11105 11106 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11104 def request_path @request_path end |
#response ⇒ String
Creates a content-based HTTPS health check. In addition to the required HTTP
200 (OK) status code, you can configure the health check to pass only when the
backend sends this specific ASCII response string within the first 1024 bytes
of the HTTP response body. For details, see: https://cloud.google.com/load-
balancing/docs/health-check-concepts#criteria-protocol-http
Corresponds to the JSON property response
11113 11114 11115 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11113 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13178 13179 13180 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13178 def self_link @self_link 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
13185 13186 13187 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13185 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
13191 13192 13193 |
# File 'lib/google/apis/compute_v1/classes.rb', line 13191 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11120 11121 11122 11123 11124 11125 11126 11127 11128 |
# File 'lib/google/apis/compute_v1/classes.rb', line 11120 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) end |