Class: Google::Apis::AppengineV1::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/appengine_v1/classes.rb,
generated/google/apis/appengine_v1/representations.rb,
generated/google/apis/appengine_v1/representations.rb

Overview

Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HealthCheck

Returns a new instance of HealthCheck



997
998
999
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 997

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#check_interval ⇒ String

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String) 


990
991
992
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 990

def check_interval
  @check_interval
end

#disable_health_check ⇒ Boolean Also known as: disable_health_check?

Whether to explicitly disable health checks for this instance. Corresponds to the JSON property disableHealthCheck

Returns:

  • (Boolean) 


966
967
968
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 966

def disable_health_check
  @disable_health_check
end

#healthy_threshold ⇒ Fixnum

Number of consecutive successful health checks required before receiving traffic. Corresponds to the JSON property healthyThreshold

Returns:

  • (Fixnum) 


985
986
987
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 985

def healthy_threshold
  @healthy_threshold
end

#host ⇒ String

Host header to send when performing an HTTP health check. Example: "myapp. appspot.com" Corresponds to the JSON property host

Returns:

  • (String) 


973
974
975
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 973

def host
  @host
end

#restart_threshold ⇒ Fixnum

Number of consecutive failed health checks required before an instance is restarted. Corresponds to the JSON property restartThreshold

Returns:

  • (Fixnum) 


979
980
981
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 979

def restart_threshold
  @restart_threshold
end

#timeout ⇒ String

Time before the health check is considered failed. Corresponds to the JSON property timeout

Returns:

  • (String) 


995
996
997
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 995

def timeout
  @timeout
end

#unhealthy_threshold ⇒ Fixnum

Number of consecutive failed health checks required before removing traffic. Corresponds to the JSON property unhealthyThreshold

Returns:

  • (Fixnum) 


961
962
963
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 961

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1002

def update!(**args)
  @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold)
  @disable_health_check = args[:disable_health_check] if args.key?(:disable_health_check)
  @host = args[:host] if args.key?(:host)
  @restart_threshold = args[:restart_threshold] if args.key?(:restart_threshold)
  @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold)
  @check_interval = args[:check_interval] if args.key?(:check_interval)
  @timeout = args[:timeout] if args.key?(:timeout)
end