Class: Google::Apis::ComputeBeta::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/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 The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP( S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require legacy HTTP health checks: * Target pool-based network load balancer 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.



12058
12059
12060
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12058

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) 


11950
11951
11952
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11950

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) 


11955
11956
11957
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11955

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) 


11961
11962
11963
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11961

def description
  @description
end

#grpc_health_check ⇒ Google::Apis::ComputeBeta::GrpcHealthCheck

Corresponds to the JSON property grpcHealthCheck

Returns:



11966
11967
11968
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11966

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

Returns:

  • (Fixnum) 


11972
11973
11974
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11972

def healthy_threshold
  @healthy_threshold
end

#http2_health_check ⇒ Google::Apis::ComputeBeta::Http2HealthCheck

Corresponds to the JSON property http2HealthCheck

Returns:



11977
11978
11979
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11977

def http2_health_check
  @http2_health_check
end

#http_health_check ⇒ Google::Apis::ComputeBeta::HttpHealthCheck

Corresponds to the JSON property httpHealthCheck

Returns:



11982
11983
11984
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11982

def http_health_check
  @http_health_check
end

#https_health_check ⇒ Google::Apis::ComputeBeta::HttpsHealthCheck

Corresponds to the JSON property httpsHealthCheck

Returns:



11987
11988
11989
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11987

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) 


11993
11994
11995
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11993

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


11998
11999
12000
 
# File 'lib/google/apis/compute_beta/classes.rb', line 11998

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeBeta::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:



12004
12005
12006
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12004

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) 


12015
12016
12017
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12015

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) 


12021
12022
12023
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12021

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


12026
12027
12028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12026

def self_link
  @self_link
end

#ssl_health_check ⇒ Google::Apis::ComputeBeta::SslHealthCheck

Corresponds to the JSON property sslHealthCheck

Returns:



12031
12032
12033
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12031

def ssl_health_check
  @ssl_health_check
end

#tcp_health_check ⇒ Google::Apis::ComputeBeta::TcpHealthCheck

Corresponds to the JSON property tcpHealthCheck

Returns:



12036
12037
12038
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12036

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) 


12043
12044
12045
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12043

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) 


12050
12051
12052
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12050

def type
  @type
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) 


12056
12057
12058
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12056

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12063

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