Class HealthCheck (1.10.1)

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/v1/healthChecks> * Regional </compute/docs/reference/rest/v1/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). Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks). Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks). 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.

Values: UNDEFINED_TYPE (0): A value indicating that the enum field is not set. GRPC (2196510): No description available. HTTP (2228360): No description available. HTTP2 (69079210): No description available. HTTPS (69079243): No description available. INVALID (530283991): No description available. SSL (82412): No description available. TCP (82881): No description available.