Class: Google::Apis::AppengineV1::ReadinessCheck

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

Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.

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) ⇒ ReadinessCheck

Returns a new instance of ReadinessCheck



2023
2024
2025
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2023

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

Instance Attribute Details

#app_start_timeout ⇒ String

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. Corresponds to the JSON property appStartTimeout

Returns:

  • (String) 


1990
1991
1992
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1990

def app_start_timeout
  @app_start_timeout
end

#check_interval ⇒ String

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String) 


1995
1996
1997
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 1995

def check_interval
  @check_interval
end

#failure_threshold ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2000
2001
2002
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2000

def failure_threshold
  @failure_threshold
end

#host ⇒ String

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

Returns:

  • (String) 


2006
2007
2008
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2006

def host
  @host
end

#path ⇒ String

The request path. Corresponds to the JSON property path

Returns:

  • (String) 


2011
2012
2013
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2011

def path
  @path
end

#success_threshold ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2016
2017
2018
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2016

def success_threshold
  @success_threshold
end

#timeout ⇒ String

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

Returns:

  • (String) 


2021
2022
2023
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2021

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2028
2029
2030
2031
2032
2033
2034
2035
2036
 
# File 'generated/google/apis/appengine_v1/classes.rb', line 2028

def update!(**args)
  @app_start_timeout = args[:app_start_timeout] if args.key?(:app_start_timeout)
  @check_interval = args[:check_interval] if args.key?(:check_interval)
  @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold)
  @host = args[:host] if args.key?(:host)
  @path = args[:path] if args.key?(:path)
  @success_threshold = args[:success_threshold] if args.key?(:success_threshold)
  @timeout = args[:timeout] if args.key?(:timeout)
end