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.


2088
2089
2090
# File 'generated/google/apis/appengine_v1/classes.rb', line 2088

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

Instance Attribute Details

#app_start_timeoutString

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)

2055
2056
2057
# File 'generated/google/apis/appengine_v1/classes.rb', line 2055

def app_start_timeout
  @app_start_timeout
end

#check_intervalString

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String)

2060
2061
2062
# File 'generated/google/apis/appengine_v1/classes.rb', line 2060

def check_interval
  @check_interval
end

#failure_thresholdFixnum

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

Returns:

  • (Fixnum)

2065
2066
2067
# File 'generated/google/apis/appengine_v1/classes.rb', line 2065

def failure_threshold
  @failure_threshold
end

#hostString

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

Returns:

  • (String)

2071
2072
2073
# File 'generated/google/apis/appengine_v1/classes.rb', line 2071

def host
  @host
end

#pathString

The request path. Corresponds to the JSON property path

Returns:

  • (String)

2076
2077
2078
# File 'generated/google/apis/appengine_v1/classes.rb', line 2076

def path
  @path
end

#success_thresholdFixnum

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

Returns:

  • (Fixnum)

2081
2082
2083
# File 'generated/google/apis/appengine_v1/classes.rb', line 2081

def success_threshold
  @success_threshold
end

#timeoutString

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

Returns:

  • (String)

2086
2087
2088
# File 'generated/google/apis/appengine_v1/classes.rb', line 2086

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2093
2094
2095
2096
2097
2098
2099
2100
2101
# File 'generated/google/apis/appengine_v1/classes.rb', line 2093

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