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



1588
1589
1590
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1588

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

Instance Attribute Details

#check_interval ⇒ String

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String) 


1581
1582
1583
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1581

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) 


1557
1558
1559
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1557

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) 


1576
1577
1578
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1576

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) 


1564
1565
1566
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1564

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) 


1570
1571
1572
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1570

def restart_threshold
  @restart_threshold
end

#timeout ⇒ String

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

Returns:

  • (String) 


1586
1587
1588
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1586

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) 


1552
1553
1554
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1552

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1593
1594
1595
1596
1597
1598
1599
1600
1601
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1593

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