Class: Google::Cloud::AppEngine::V1::HealthCheck

Inherits:

Object

• Object
• Google::Cloud::AppEngine::V1::HealthCheck

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/appengine/v1/app_yaml.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

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

  Interval between health checks.

• #disable_health_check ⇒ ::Boolean

  Whether to explicitly disable health checks for this instance.

• #healthy_threshold ⇒ ::Integer

  Number of consecutive successful health checks required before receiving traffic.

• #host ⇒ ::String

  Host header to send when performing an HTTP health check.

• #restart_threshold ⇒ ::Integer

  Number of consecutive failed health checks required before an instance is restarted.

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

  Time before the health check is considered failed.

• #unhealthy_threshold ⇒ ::Integer

  Number of consecutive failed health checks required before removing traffic.

Instance Attribute Details

#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 237

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

#disable_health_check ⇒ ::Boolean

Returns Whether to explicitly disable health checks for this instance.

Returns:

• (::Boolean) —

  Whether to explicitly disable health checks for this instance.

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

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

#healthy_threshold ⇒ ::Integer

Returns Number of consecutive successful health checks required before receiving traffic.

Returns:

• (::Integer) —

  Number of consecutive successful health checks required before receiving traffic.

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

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

#host ⇒ ::String

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

Returns:

• (::String) —

  Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"

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

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

#restart_threshold ⇒ ::Integer

Returns Number of consecutive failed health checks required before an instance is restarted.

Returns:

• (::Integer) —

  Number of consecutive failed health checks required before an instance is restarted.

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

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

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

Returns Time before the health check is considered failed.

Returns:

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

  Time before the health check is considered failed.

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

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

#unhealthy_threshold ⇒ ::Integer

Returns Number of consecutive failed health checks required before removing traffic.

Returns:

• (::Integer) —

  Number of consecutive failed health checks required before removing traffic.

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

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