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
Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
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.
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.
8683 8684 8685 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8683 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
9979 9980 9981 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9979 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
9984 9985 9986 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9984 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
9990 9991 9992 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9990 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
9996 9997 9998 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9996 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
8638 8639 8640 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8638 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
10009 10010 10011 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10009 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
10015 10016 10017 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10015 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
10025 10026 10027 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10025 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
8644 8645 8646 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8644 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
8650 8651 8652 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8650 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
8663 8664 8665 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8663 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
8669 8670 8671 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8669 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
8674 8675 8676 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8674 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
8681 8682 8683 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8681 def response @response end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
10041 10042 10043 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10041 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
10046 10047 10048 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10046 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
10053 10054 10055 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10053 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
10059 10060 10061 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 10059 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8688 8689 8690 8691 8692 8693 8694 8695 8696 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8688 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 |