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.
11477 11478 11479 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11477 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
11359 11360 11361 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11359 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
11364 11365 11366 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11364 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
11370 11371 11372 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11370 def description @description end |
#grpc_health_check ⇒ Google::Apis::ComputeAlpha::GrpcHealthCheck
Corresponds to the JSON property grpcHealthCheck
11375 11376 11377 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11375 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
11381 11382 11383 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11381 def healthy_threshold @healthy_threshold end |
#http2_health_check ⇒ Google::Apis::ComputeAlpha::Http2HealthCheck
Corresponds to the JSON property http2HealthCheck
11386 11387 11388 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11386 def http2_health_check @http2_health_check end |
#http_health_check ⇒ Google::Apis::ComputeAlpha::HttpHealthCheck
Corresponds to the JSON property httpHealthCheck
11391 11392 11393 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11391 def http_health_check @http_health_check end |
#https_health_check ⇒ Google::Apis::ComputeAlpha::HttpsHealthCheck
Corresponds to the JSON property httpsHealthCheck
11396 11397 11398 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11396 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
11402 11403 11404 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11402 def id @id end |
#kind ⇒ String
Type of the resource.
Corresponds to the JSON property kind
11407 11408 11409 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11407 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
11413 11414 11415 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11413 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
11424 11425 11426 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11424 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
11430 11431 11432 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11430 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
11435 11436 11437 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11435 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
11440 11441 11442 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11440 def self_link_with_id @self_link_with_id end |
#ssl_health_check ⇒ Google::Apis::ComputeAlpha::SslHealthCheck
Corresponds to the JSON property sslHealthCheck
11445 11446 11447 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11445 def ssl_health_check @ssl_health_check end |
#tcp_health_check ⇒ Google::Apis::ComputeAlpha::TcpHealthCheck
Corresponds to the JSON property tcpHealthCheck
11450 11451 11452 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11450 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
11457 11458 11459 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11457 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
11464 11465 11466 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11464 def type @type end |
#udp_health_check ⇒ Google::Apis::ComputeAlpha::UdpHealthCheck
Corresponds to the JSON property udpHealthCheck
11469 11470 11471 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11469 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
11475 11476 11477 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11475 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 11482 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 |