Class HealthCheck (0.6.0)

Version 0.6.0

• 1.20.1 (latest)
• 1.20.0
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

HealthCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a Health Check resource.

Google Compute Engine has two Health Check resources:

• Global </compute/docs/reference/rest/{$api_version}/healthChecks> * Regional </compute/docs/reference/rest/{$api_version}/regionHealthChecks>

Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks).

Traffic Director must use global health checks (compute.v1.HealthChecks).

Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks or compute.v1.HealthChecks).

External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.HealthChecks).

Network load balancers must use legacy HTTP health checks (httpHealthChecks).

For more information, see Health checks overview.

Attributes

Name	Description
check_interval_sec	int How often (in seconds) to send a health check. The default value is 5 seconds.
creation_timestamp	str [Output Only] Creation timestamp in 3339 text format.
description	str An optional description of this resource. Provide this property when you create the resource.
healthy_threshold	int A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kind	str Type of the resource.
log_config	google.cloud.compute_v1.types.HealthCheckLogConfig Configure logging on this health check.
name	str 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.
region	str [Output Only] Region where the health check resides. Not applicable to global health checks.
self_link	str [Output Only] Server-defined URL for the resource.
timeout_sec	int 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.
type_	google.cloud.compute_v1.types.HealthCheck.Type Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
unhealthy_threshold	int A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Classes

Type

Type(value)

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.