Compute Engine v1 API - Class HealthCheck (3.2.0)

Reference documentation and code samples for the Compute Engine v1 API class HealthCheck.

Represents a health check resource. Google Compute Engine has two health check resources: * Regional * Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.

How often (in seconds) to send a health check. The default value is 5 seconds.

[Output Only] Creation timestamp in 3339 text format.

An optional description of this resource. Provide this property when you create the resource.

Gets whether the "check_interval_sec" field is set

Gets whether the "creation_timestamp" field is set

Gets whether the "description" field is set

Gets whether the "healthy_threshold" field is set

Gets whether the "id" field is set

Gets whether the "kind" field is set

Gets whether the "name" field is set

Gets whether the "region" field is set

Gets whether the "self_link" field is set

Gets whether the "timeout_sec" field is set

Gets whether the "type" field is set

Gets whether the "unhealthy_threshold" field is set

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Type of the resource.

Configure logging on this health check.

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.

[Output Only] Region where the health check resides. Not applicable to global health checks.

[Output Only] Server-defined URL for the resource.

The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Check the Type enum for the list of possible values.

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.