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.
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class HealthCheck : IDirectResponseSchema
Properties
CheckIntervalSec
How often (in seconds) to send a health check. The default value is 5 seconds.
Declaration
[JsonProperty("checkIntervalSec")]
public virtual int? CheckIntervalSec { get; set; }
Property Value
CreationTimestamp
[Output Only] Creation timestamp in 3339 text format.
Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Description
An optional description of this resource. Provide this property when you create the resource.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
ETag
Declaration
public virtual string ETag { get; set; }
Property Value
GrpcHealthCheck
Declaration
[JsonProperty("grpcHealthCheck")]
public virtual GRPCHealthCheck GrpcHealthCheck { get; set; }
Property Value
HealthyThreshold
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value
is 2.
Declaration
[JsonProperty("healthyThreshold")]
public virtual int? HealthyThreshold { get; set; }
Property Value
Http2HealthCheck
Declaration
[JsonProperty("http2HealthCheck")]
public virtual HTTP2HealthCheck Http2HealthCheck { get; set; }
Property Value
HttpHealthCheck
Declaration
[JsonProperty("httpHealthCheck")]
public virtual HTTPHealthCheck HttpHealthCheck { get; set; }
Property Value
HttpsHealthCheck
Declaration
[JsonProperty("httpsHealthCheck")]
public virtual HTTPSHealthCheck HttpsHealthCheck { get; set; }
Property Value
Id
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Kind
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
LogConfig
Configure logging on this health check.
Declaration
[JsonProperty("logConfig")]
public virtual HealthCheckLogConfig LogConfig { get; set; }
Property Value
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Region
[Output Only] Region where the health check resides. Not applicable to global health checks.
Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
SelfLink
[Output Only] Server-defined URL for the resource.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
SelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
SourceRegions
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 GCP 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.
Declaration
[JsonProperty("sourceRegions")]
public virtual IList<string> SourceRegions { get; set; }
Property Value
SslHealthCheck
Declaration
[JsonProperty("sslHealthCheck")]
public virtual SSLHealthCheck SslHealthCheck { get; set; }
Property Value
TcpHealthCheck
Declaration
[JsonProperty("tcpHealthCheck")]
public virtual TCPHealthCheck TcpHealthCheck { get; set; }
Property Value
TimeoutSec
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.
Declaration
[JsonProperty("timeoutSec")]
public virtual int? TimeoutSec { get; set; }
Property Value
Type
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.
Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
UdpHealthCheck
Declaration
[JsonProperty("udpHealthCheck")]
public virtual UDPHealthCheck UdpHealthCheck { get; set; }
Property Value
UnhealthyThreshold
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value
is 2.
Declaration
[JsonProperty("unhealthyThreshold")]
public virtual int? UnhealthyThreshold { get; set; }
Property Value
Implements