Class: Google::Apis::ComputeAlpha::HealthCheck

Inherits:
Object
  • Object
show all
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: * Regional

  • Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HealthCheck

Returns a new instance of HealthCheck.



14028
14029
14030
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14028

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

Returns:

  • (Fixnum) 


13891
13892
13893
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13891

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

Returns:

  • (String) 


13896
13897
13898
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13896

def creation_timestamp
  @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

Returns:

  • (String) 


13902
13903
13904
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13902

def description
  @description
end

#grpc_health_check ⇒ Google::Apis::ComputeAlpha::GrpcHealthCheck

Corresponds to the JSON property grpcHealthCheck

Returns:



13907
13908
13909
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13907

def grpc_health_check
  @grpc_health_check
end

#grpc_tls_health_check ⇒ Google::Apis::ComputeAlpha::GrpctlsHealthCheck

Corresponds to the JSON property grpcTlsHealthCheck

Returns:



13912
13913
13914
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13912

def grpc_tls_health_check
  @grpc_tls_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

Returns:

  • (Fixnum) 


13918
13919
13920
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13918

def healthy_threshold
  @healthy_threshold
end

#http2_health_check ⇒ Google::Apis::ComputeAlpha::Http2HealthCheck

Corresponds to the JSON property http2HealthCheck

Returns:



13923
13924
13925
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13923

def http2_health_check
  @http2_health_check
end

#http_health_check ⇒ Google::Apis::ComputeAlpha::HttpHealthCheck

Corresponds to the JSON property httpHealthCheck

Returns:



13928
13929
13930
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13928

def http_health_check
  @http_health_check
end

#https_health_check ⇒ Google::Apis::ComputeAlpha::HttpsHealthCheck

Corresponds to the JSON property httpsHealthCheck

Returns:



13933
13934
13935
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13933

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

Returns:

  • (Fixnum) 


13939
13940
13941
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13939

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


13944
13945
13946
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13944

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

Returns:



13950
13951
13952
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13950

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

Returns:

  • (String) 


13961
13962
13963
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13961

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

Returns:

  • (String) 


13967
13968
13969
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13967

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


13972
13973
13974
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13972

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

Returns:

  • (String) 


13977
13978
13979
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13977

def self_link_with_id
  @self_link_with_id
end

#source_regions ⇒ Array<String>

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. Corresponds to the JSON property sourceRegions

Returns:

  • (Array<String>) 


13991
13992
13993
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13991

def source_regions
  @source_regions
end

#ssl_health_check ⇒ Google::Apis::ComputeAlpha::SslHealthCheck

Corresponds to the JSON property sslHealthCheck

Returns:



13996
13997
13998
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13996

def ssl_health_check
  @ssl_health_check
end

#tcp_health_check ⇒ Google::Apis::ComputeAlpha::TcpHealthCheck

Corresponds to the JSON property tcpHealthCheck

Returns:



14001
14002
14003
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14001

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

Returns:

  • (Fixnum) 


14008
14009
14010
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14008

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

Returns:

  • (String) 


14015
14016
14017
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14015

def type
  @type
end

#udp_health_check ⇒ Google::Apis::ComputeAlpha::UdpHealthCheck

Corresponds to the JSON property udpHealthCheck

Returns:



14020
14021
14022
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14020

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

Returns:

  • (Fixnum) 


14026
14027
14028
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14026

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 14033

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)
  @grpc_tls_health_check = args[:grpc_tls_health_check] if args.key?(:grpc_tls_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)
  @source_regions = args[:source_regions] if args.key?(:source_regions)
  @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