Class: Google::Apis::ComputeAlpha::HttpHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HttpHealthCheck
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
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.
-
#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) ⇒ HttpHealthCheck
constructor
A new instance of HttpHealthCheck.
-
#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) ⇒ HttpHealthCheck
Returns a new instance of HttpHealthCheck
6588 6589 6590 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6588 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
8145 8146 8147 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8145 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
8150 8151 8152 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8150 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
8156 8157 8158 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8156 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
8162 8163 8164 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8162 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
6536 6537 6538 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6536 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
8175 8176 8177 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8175 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
8181 8182 8183 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8181 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
8191 8192 8193 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8191 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
6542 6543 6544 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6542 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
6548 6549 6550 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6548 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
6568 6569 6570 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6568 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
6574 6575 6576 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6574 def proxy_header @proxy_header end |
#request_path ⇒ String
The request path of the HTTP health check request. The default value is /.
Corresponds to the JSON property requestPath
6579 6580 6581 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6579 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
6586 6587 6588 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6586 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
8206 8207 8208 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8206 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 greater value than
checkIntervalSec.
Corresponds to the JSON property timeoutSec
8213 8214 8215 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8213 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
8219 8220 8221 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8219 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6593 6594 6595 6596 6597 6598 6599 6600 6601 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 6593 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 |