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
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 HTTP 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) ⇒ 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.
11237 11238 11239 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11237 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
12830 12831 12832 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12830 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
12835 12836 12837 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12835 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
12841 12842 12843 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12841 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
12847 12848 12849 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12847 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
11189 11190 11191 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11189 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
12860 12861 12862 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12860 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
12866 12867 12868 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12866 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
12876 12877 12878 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12876 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
11195 11196 11197 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11195 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
11201 11202 11203 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11201 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, HTTP health
check follows behavior specified in port and portName fields.
Corresponds to the JSON property portSpecification
11212 11213 11214 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11212 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
11218 11219 11220 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11218 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.
Corresponds to the JSON property requestPath
11223 11224 11225 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11223 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
11230 11231 11232 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11230 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
12892 12893 12894 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12892 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
12897 12898 12899 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12897 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
12904 12905 12906 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12904 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
12910 12911 12912 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 12910 def unhealthy_threshold @unhealthy_threshold end |
#weight_report_mode ⇒ String
Weight report mode. used for weighted Load Balancing.
Corresponds to the JSON property weightReportMode
11235 11236 11237 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11235 def weight_report_mode @weight_report_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11242 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 |