Class: Google::Apis::AppengineV1beta::ReadinessCheck

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



2171
2172
2173
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2171

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)


2138
2139
2140
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2138

def app_start_timeout
  @app_start_timeout
end

#check_intervalString

Interval between health checks. Corresponds to the JSON property checkInterval

Returns:

  • (String)


2143
2144
2145
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2143

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)


2148
2149
2150
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2148

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)


2154
2155
2156
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2154

def host
  @host
end

#pathString

The request path. Corresponds to the JSON property path

Returns:

  • (String)


2159
2160
2161
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2159

def path
  @path
end

#success_thresholdFixnum

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

Returns:

  • (Fixnum)


2164
2165
2166
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2164

def success_threshold
  @success_threshold
end

#timeoutString

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

Returns:

  • (String)


2169
2170
2171
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2169

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2176
2177
2178
2179
2180
2181
2182
2183
2184
# File 'generated/google/apis/appengine_v1beta/classes.rb', line 2176

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