public sealed class HealthCheck : IMessage<HealthCheck>, IEquatable<HealthCheck>, IDeepCloneable<HealthCheck>, IBufferMessage, IMessage
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: * Global * Regional 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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-08 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eHealthCheck\u003c/code\u003e class is part of the Google Compute Engine v1 API and is used to monitor the health of resources, with different configurations for global, regional, and legacy health checks.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation includes various versions of the \u003ccode\u003eHealthCheck\u003c/code\u003e class, with the latest being version 3.6.0 and the oldest being 1.0.0, all of which can be accessed through the provided links.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHealthCheck\u003c/code\u003e resource can be configured with properties such as \u003ccode\u003eCheckIntervalSec\u003c/code\u003e, \u003ccode\u003eHealthyThreshold\u003c/code\u003e, \u003ccode\u003eTimeoutSec\u003c/code\u003e, and specific health check types like \u003ccode\u003eGRPCHealthCheck\u003c/code\u003e, \u003ccode\u003eHTTPHealthCheck\u003c/code\u003e, \u003ccode\u003eHTTPSHealthCheck\u003c/code\u003e, \u003ccode\u003eSSLHealthCheck\u003c/code\u003e, and \u003ccode\u003eTCPHealthCheck\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHealthCheck\u003c/code\u003e class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e, offering functionalities such as cloning, equality checks, and message buffering.\u003c/p\u003e\n"],["\u003cp\u003eThere are different types of health checks available including \u003ccode\u003eTCP\u003c/code\u003e, \u003ccode\u003eSSL\u003c/code\u003e, \u003ccode\u003eHTTP\u003c/code\u003e, \u003ccode\u003eHTTPS\u003c/code\u003e, \u003ccode\u003eHTTP2\u003c/code\u003e or \u003ccode\u003eGRPC\u003c/code\u003e and the type must match the specified health check field.\u003c/p\u003e\n"]]],[],null,[]]
