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.

Inheritance
object
HealthCheck
Implements
Inherited Members
Namespace: Google.Apis.Compute.beta.Data
Assembly: Google.Apis.Compute.beta.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
Type Description
int?

CreationTimestamp

[Output Only] Creation timestamp in 3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
string

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
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

GrpcHealthCheck

Declaration
[JsonProperty("grpcHealthCheck")]
public virtual GRPCHealthCheck GrpcHealthCheck { get; set; }
Property Value
Type Description
GRPCHealthCheck

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
Type Description
int?

Http2HealthCheck

Declaration
[JsonProperty("http2HealthCheck")]
public virtual HTTP2HealthCheck Http2HealthCheck { get; set; }
Property Value
Type Description
HTTP2HealthCheck

HttpHealthCheck

Declaration
[JsonProperty("httpHealthCheck")]
public virtual HTTPHealthCheck HttpHealthCheck { get; set; }
Property Value
Type Description
HTTPHealthCheck

HttpsHealthCheck

Declaration
[JsonProperty("httpsHealthCheck")]
public virtual HTTPSHealthCheck HttpsHealthCheck { get; set; }
Property Value
Type Description
HTTPSHealthCheck

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
Type Description
ulong?

Kind

Type of the resource.

Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type Description
string

LogConfig

Configure logging on this health check.

Declaration
[JsonProperty("logConfig")]
public virtual HealthCheckLogConfig LogConfig { get; set; }
Property Value
Type Description
HealthCheckLogConfig

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
Type Description
string

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
Type Description
string

[Output Only] Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

SslHealthCheck

Declaration
[JsonProperty("sslHealthCheck")]
public virtual SSLHealthCheck SslHealthCheck { get; set; }
Property Value
Type Description
SSLHealthCheck

TcpHealthCheck

Declaration
[JsonProperty("tcpHealthCheck")]
public virtual TCPHealthCheck TcpHealthCheck { get; set; }
Property Value
Type Description
TCPHealthCheck

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 Description
int?

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
Type Description
string

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
Type Description
int?

Implements