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.



13061
13062
13063
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13061

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) 


12924
12925
12926
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12924

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) 


12929
12930
12931
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12929

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) 


12935
12936
12937
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12935

def description
  @description
end

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

Corresponds to the JSON property grpcHealthCheck

Returns:



12940
12941
12942
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12940

def grpc_health_check
  @grpc_health_check
end

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

Corresponds to the JSON property grpcTlsHealthCheck

Returns:



12945
12946
12947
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12945

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) 


12951
12952
12953
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12951

def healthy_threshold
  @healthy_threshold
end

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

Corresponds to the JSON property http2HealthCheck

Returns:



12956
12957
12958
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12956

def http2_health_check
  @http2_health_check
end

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

Corresponds to the JSON property httpHealthCheck

Returns:



12961
12962
12963
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12961

def http_health_check
  @http_health_check
end

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

Corresponds to the JSON property httpsHealthCheck

Returns:



12966
12967
12968
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12966

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) 


12972
12973
12974
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12972

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


12977
12978
12979
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12977

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:



12983
12984
12985
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12983

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) 


12994
12995
12996
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12994

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) 


13000
13001
13002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13000

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


13005
13006
13007
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13005

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) 


13010
13011
13012
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13010

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 GCP 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>) 


13024
13025
13026
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13024

def source_regions
  @source_regions
end

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

Corresponds to the JSON property sslHealthCheck

Returns:



13029
13030
13031
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13029

def ssl_health_check
  @ssl_health_check
end

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

Corresponds to the JSON property tcpHealthCheck

Returns:



13034
13035
13036
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13034

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) 


13041
13042
13043
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13041

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) 


13048
13049
13050
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13048

def type
  @type
end

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

Corresponds to the JSON property udpHealthCheck

Returns:



13053
13054
13055
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13053

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) 


13059
13060
13061
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13059

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 13066

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