Class: Google::Cloud::AppEngine::V1::ReadinessCheck

Inherits:

Object

• Object
• Google::Cloud::AppEngine::V1::ReadinessCheck

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/appengine/v1/app_yaml.rb

Overview

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

Instance Attribute Summary

• #app_start_timeout ⇒ ::Google::Protobuf::Duration

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

• #check_interval ⇒ ::Google::Protobuf::Duration

  Interval between health checks.

• #failure_threshold ⇒ ::Integer

  Number of consecutive failed checks required before removing traffic.

• #host ⇒ ::String

  Host header to send when performing a HTTP Readiness check.

• #path ⇒ ::String

  The request path.

• #success_threshold ⇒ ::Integer

  Number of consecutive successful checks required before receiving traffic.

• #timeout ⇒ ::Google::Protobuf::Duration

  Time before the check is considered failed.

Instance Attribute Details

#app_start_timeout ⇒ ::Google::Protobuf::Duration

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

Returns:

• (::Google::Protobuf::Duration) —

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

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#check_interval ⇒ ::Google::Protobuf::Duration

Returns Interval between health checks.

Returns:

• (::Google::Protobuf::Duration) —

  Interval between health checks.

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#failure_threshold ⇒ ::Integer

Returns Number of consecutive failed checks required before removing traffic.

Returns:

• (::Integer) —

  Number of consecutive failed checks required before removing traffic.

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#host ⇒ ::String

Returns Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com".

Returns:

• (::String) —

  Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#path ⇒ ::String

Returns The request path.

Returns:

• (::String) —

  The request path.

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#success_threshold ⇒ ::Integer

Returns Number of consecutive successful checks required before receiving traffic.

Returns:

• (::Integer) —

  Number of consecutive successful checks required before receiving traffic.

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timeout ⇒ ::Google::Protobuf::Duration

Returns Time before the check is considered failed.

Returns:

• (::Google::Protobuf::Duration) —

  Time before the check is considered failed.

# File 'proto_docs/google/appengine/v1/app_yaml.rb', line 270

class ReadinessCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end