Class: Google::Apis::ComputeAlpha::HealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HealthCheck
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents a Health Check resource. Google Compute Engine has two Health Check
resources: * Global *
Regional Internal HTTP(
S) load balancers must use regional health checks (compute.v1.
regionHealthChecks
). Traffic Director must use global health checks (compute.
v1.HealthChecks
). Internal TCP/UDP load balancers can use either regional or
global health checks (compute.v1.regionHealthChecks
or compute.v1.
HealthChecks
). External HTTP(S), TCP proxy, and SSL proxy load balancers as
well as managed instance group auto-healing must use global health checks (
compute.v1.HealthChecks
). Backend service-based network load balancers must
use regional health checks (compute.v1.regionHealthChecks
). Target pool-
based network load balancers must use legacy HTTP health checks (compute.v1.
httpHealthChecks
). 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 3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#grpc_health_check ⇒ Google::Apis::ComputeAlpha::GrpcHealthCheck
Corresponds to the JSON property
grpcHealthCheck
. -
#healthy_threshold ⇒ Fixnum
A so-far unhealthy instance will be marked healthy after this many consecutive successes.
-
#http2_health_check ⇒ Google::Apis::ComputeAlpha::Http2HealthCheck
Corresponds to the JSON property
http2HealthCheck
. -
#http_health_check ⇒ Google::Apis::ComputeAlpha::HttpHealthCheck
Corresponds to the JSON property
httpHealthCheck
. -
#https_health_check ⇒ Google::Apis::ComputeAlpha::HttpsHealthCheck
Corresponds to the JSON property
httpsHealthCheck
. -
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
Type of the resource.
-
#log_config ⇒ Google::Apis::ComputeAlpha::HealthCheckLogConfig
Configuration of logging on a health check.
-
#name ⇒ String
Name of the resource.
-
#region ⇒ String
[Output Only] Region where the health check resides.
-
#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.
-
#ssl_health_check ⇒ Google::Apis::ComputeAlpha::SslHealthCheck
Corresponds to the JSON property
sslHealthCheck
. -
#tcp_health_check ⇒ Google::Apis::ComputeAlpha::TcpHealthCheck
Corresponds to the JSON property
tcpHealthCheck
. -
#timeout_sec ⇒ Fixnum
How long (in seconds) to wait before claiming failure.
-
#type ⇒ String
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC.
-
#udp_health_check ⇒ Google::Apis::ComputeAlpha::UdpHealthCheck
Corresponds to the JSON property
udpHealthCheck
. -
#unhealthy_threshold ⇒ Fixnum
A so-far healthy instance will be marked unhealthy after this many consecutive failures.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HealthCheck
constructor
A new instance of HealthCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ HealthCheck
Returns a new instance of HealthCheck.
11692 11693 11694 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11692 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
11574 11575 11576 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11574 def check_interval_sec @check_interval_sec end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in 3339 text format.
Corresponds to the JSON property creationTimestamp
11579 11580 11581 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11579 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
11585 11586 11587 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11585 def description @description end |
#grpc_health_check ⇒ Google::Apis::ComputeAlpha::GrpcHealthCheck
Corresponds to the JSON property grpcHealthCheck
11590 11591 11592 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11590 def grpc_health_check @grpc_health_check 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
11596 11597 11598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11596 def healthy_threshold @healthy_threshold end |
#http2_health_check ⇒ Google::Apis::ComputeAlpha::Http2HealthCheck
Corresponds to the JSON property http2HealthCheck
11601 11602 11603 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11601 def http2_health_check @http2_health_check end |
#http_health_check ⇒ Google::Apis::ComputeAlpha::HttpHealthCheck
Corresponds to the JSON property httpHealthCheck
11606 11607 11608 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11606 def http_health_check @http_health_check end |
#https_health_check ⇒ Google::Apis::ComputeAlpha::HttpsHealthCheck
Corresponds to the JSON property httpsHealthCheck
11611 11612 11613 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11611 def https_health_check @https_health_check end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
11617 11618 11619 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11617 def id @id end |
#kind ⇒ String
Type of the resource.
Corresponds to the JSON property kind
11622 11623 11624 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11622 def kind @kind end |
#log_config ⇒ Google::Apis::ComputeAlpha::HealthCheckLogConfig
Configuration of logging on a health check. If logging is enabled, logs will
be exported to Stackdriver.
Corresponds to the JSON property logConfig
11628 11629 11630 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11628 def log_config @log_config 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. For example, a
name that is 1-63 characters long, matches the regular expression [a-z]([-a-
z0-9]*[a-z0-9])?
, and otherwise complies with RFC1035. This regular
expression describes a name where the first character is a lowercase letter,
and all following characters are a dash, lowercase letter, or digit, except
the last character, which isn't a dash.
Corresponds to the JSON property name
11639 11640 11641 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11639 def name @name end |
#region ⇒ String
[Output Only] Region where the health check resides. Not applicable to global
health checks.
Corresponds to the JSON property region
11645 11646 11647 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11645 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
11650 11651 11652 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11650 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
11655 11656 11657 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11655 def self_link_with_id @self_link_with_id end |
#ssl_health_check ⇒ Google::Apis::ComputeAlpha::SslHealthCheck
Corresponds to the JSON property sslHealthCheck
11660 11661 11662 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11660 def ssl_health_check @ssl_health_check end |
#tcp_health_check ⇒ Google::Apis::ComputeAlpha::TcpHealthCheck
Corresponds to the JSON property tcpHealthCheck
11665 11666 11667 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11665 def tcp_health_check @tcp_health_check 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
11672 11673 11674 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11672 def timeout_sec @timeout_sec end |
#type ⇒ String
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or
GRPC. Exactly one of the protocol-specific health check fields must be
specified, which must match type field.
Corresponds to the JSON property type
11679 11680 11681 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11679 def type @type end |
#udp_health_check ⇒ Google::Apis::ComputeAlpha::UdpHealthCheck
Corresponds to the JSON property udpHealthCheck
11684 11685 11686 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11684 def udp_health_check @udp_health_check 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
11690 11691 11692 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11690 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11697 def update!(**args) @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @grpc_health_check = args[:grpc_health_check] if args.key?(:grpc_health_check) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @http2_health_check = args[:http2_health_check] if args.key?(:http2_health_check) @http_health_check = args[:http_health_check] if args.key?(:http_health_check) @https_health_check = args[:https_health_check] if args.key?(:https_health_check) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @log_config = args[:log_config] if args.key?(:log_config) @name = args[:name] if args.key?(:name) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @ssl_health_check = args[:ssl_health_check] if args.key?(:ssl_health_check) @tcp_health_check = args[:tcp_health_check] if args.key?(:tcp_health_check) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @type = args[:type] if args.key?(:type) @udp_health_check = args[:udp_health_check] if args.key?(:udp_health_check) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end |