Class HealthCheck

Represents a Health Check resource.

Google Compute Engine has two Health Check resources:

Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.

To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Inheritance
System.Object
HealthCheck
Implements
Google.Apis.Requests.IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Compute.v1.Data
Assembly: Google.Apis.Compute.v1.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
System.Nullable<System.Int32>

CreationTimestamp

[Output Only] Creation timestamp in 3339 text format.

Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type Description
System.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
System.String

ETag

The ETag of the item.

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

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
System.Nullable<System.Int32>

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
System.Nullable<System.UInt64>

Kind

Type of the resource.

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

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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.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
System.String

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

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
System.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
System.Nullable<System.Int32>

Type

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
System.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
System.Nullable<System.Int32>

Implements

Google.Apis.Requests.IDirectResponseSchema