Class HealthCheck (1.20.1)

Version 1.20.1

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 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: * Regional </compute/docs/reference/rest/v1/regionHealthChecks> * Global </compute/docs/reference/rest/v1/healthChecks> 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
check_interval_sec	int How often (in seconds) to send a health check. The default value is 5 seconds. This field is a member of oneof_ _check_interval_sec.
creation_timestamp	str [Output Only] Creation timestamp in 3339 text format. This field is a member of oneof_ _creation_timestamp.
description	str An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
grpc_health_check	google.cloud.compute_v1.types.GRPCHealthCheck This field is a member of oneof_ _grpc_health_check.
healthy_threshold	int A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. This field is a member of oneof_ _healthy_threshold.
http2_health_check	google.cloud.compute_v1.types.HTTP2HealthCheck This field is a member of oneof_ _http2_health_check.
http_health_check	google.cloud.compute_v1.types.HTTPHealthCheck This field is a member of oneof_ _http_health_check.
https_health_check	google.cloud.compute_v1.types.HTTPSHealthCheck This field is a member of oneof_ _https_health_check.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind	str Type of the resource. This field is a member of oneof_ _kind.
log_config	google.cloud.compute_v1.types.HealthCheckLogConfig Configure logging on this health check. This field is a member of oneof_ _log_config.
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. This field is a member of oneof_ _name.
region	str [Output Only] Region where the health check resides. Not applicable to global health checks. This field is a member of oneof_ _region.
self_link	str [Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
ssl_health_check	google.cloud.compute_v1.types.SSLHealthCheck This field is a member of oneof_ _ssl_health_check.
tcp_health_check	google.cloud.compute_v1.types.TCPHealthCheck This field is a member of oneof_ _tcp_health_check.
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. This field is a member of oneof_ _timeout_sec.
type_	str 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. This field is a member of oneof_ _type.
unhealthy_threshold	int A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. This field is a member of oneof_ _unhealthy_threshold.

Classes

Type

Type(value)

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.