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



1236
1237
1238
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1236

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

Instance Attribute Details

#check_interval ⇒ String

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String) 


1229
1230
1231
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1229

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) 


1200
1201
1202
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1200

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) 


1213
1214
1215
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1213

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) 


1207
1208
1209
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1207

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) 


1224
1225
1226
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1224

def restart_threshold
  @restart_threshold
end

#timeout ⇒ String

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

Returns:

  • (String) 


1234
1235
1236
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1234

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) 


1218
1219
1220
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1218

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'generated/google/apis/appengine_v1beta5/classes.rb', line 1241

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