Class: Google::Apis::ComputeAlpha::HttpHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HttpHealthCheck
- 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 HTTP Health Check resource. Legacy HTTP health checks are now only required by target pool-based network load balancers. 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 HTTP health check request.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#port ⇒ Fixnum
The TCP port number for the HTTP 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 HTTP health check request.
-
#response ⇒ String
Creates a content-based HTTP health check.
-
#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) ⇒ HttpHealthCheck
constructor
A new instance of HttpHealthCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ HttpHealthCheck
Returns a new instance of HttpHealthCheck.
12238 12239 12240 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12238 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
13921 13922 13923 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13921 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
13926 13927 13928 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13926 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
13932 13933 13934 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13932 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
13938 13939 13940 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13938 def healthy_threshold @healthy_threshold end |
#host ⇒ String
The value of the host header in the HTTP 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
12178 12179 12180 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12178 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
13951 13952 13953 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13951 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP
health checks.
Corresponds to the JSON property kind
13957 13958 13959 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13957 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
13967 13968 13969 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13967 def name @name end |
#port ⇒ Fixnum
The TCP port number for the HTTP health check request. The default value is 80.
Corresponds to the JSON property port
12184 12185 12186 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12184 def port @port end |
#port_name ⇒ String
Not supported.
Corresponds to the JSON property portName
12189 12190 12191 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12189 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 pass-through
load balancers and backend services for proxy load balancers. Also supported
in legacy HTTP health checks for 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 pass-through 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
12211 12212 12213 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12211 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
12217 12218 12219 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12217 def proxy_header @proxy_header end |
#request_path ⇒ String
The request path of the HTTP health check request. The default value is /.
This field does not support query parameters. Must comply with RFC3986.
Corresponds to the JSON property requestPath
12222 12223 12224 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12222 def request_path @request_path end |
#response ⇒ String
Creates a content-based HTTP 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
12231 12232 12233 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12231 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13983 13984 13985 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13983 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
13988 13989 13990 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13988 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 greater value than
checkIntervalSec.
Corresponds to the JSON property timeoutSec
13995 13996 13997 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13995 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
14001 14002 14003 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 14001 def unhealthy_threshold @unhealthy_threshold end |
#weight_report_mode ⇒ String
Weight report mode. used for weighted Load Balancing.
Corresponds to the JSON property weightReportMode
12236 12237 12238 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12236 def weight_report_mode @weight_report_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12243 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 |