Class: Google::Apis::AppengineV1beta5::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/appengine_v1beta5/classes.rb,
generated/google/apis/appengine_v1beta5/representations.rb,
generated/google/apis/appengine_v1beta5/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



625
626
627
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 625

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

Instance Attribute Details

#check_interval ⇒ String

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String) 


589
590
591
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 589

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) 


594
595
596
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 594

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) 


601
602
603
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 601

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) 


607
608
609
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 607

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) 


613
614
615
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 613

def restart_threshold
  @restart_threshold
end

#timeout ⇒ String

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

Returns:

  • (String) 


618
619
620
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 618

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) 


623
624
625
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 623

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



630
631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 630

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