Compute Engine v1 API - Class HealthCheck (2.12.0)

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: * Regional * Global These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). Load balancing The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require legacy HTTP health checks: * Target pool-based network load balancer Autohealing in MIGs The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.

Inheritance

object > HealthCheck

Implements

IMessage HealthCheck, IEquatable HealthCheck, IDeepCloneable HealthCheck, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

HealthCheck()

public HealthCheck()

HealthCheck(HealthCheck)

public HealthCheck(HealthCheck other)

Parameter
Name	Description
`other`	`HealthCheck`

Properties

CheckIntervalSec

public int CheckIntervalSec { get; set; }

How often (in seconds) to send a health check. The default value is 5 seconds.

Property Value
Type	Description
`int`

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in 3339 text format.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

An optional description of this resource. Provide this property when you create the resource.

Property Value
Type	Description
`string`

GrpcHealthCheck

public GRPCHealthCheck GrpcHealthCheck { get; set; }

Property Value
Type	Description
`GRPCHealthCheck`

HasCheckIntervalSec

public bool HasCheckIntervalSec { get; }

Gets whether the "check_interval_sec" field is set

Property Value
Type	Description
`bool`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasHealthyThreshold

public bool HasHealthyThreshold { get; }

Gets whether the "healthy_threshold" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HasTimeoutSec

public bool HasTimeoutSec { get; }

Gets whether the "timeout_sec" field is set

Property Value
Type	Description
`bool`

HasType

public bool HasType { get; }

Gets whether the "type" field is set

Property Value
Type	Description
`bool`

HasUnhealthyThreshold

public bool HasUnhealthyThreshold { get; }

Gets whether the "unhealthy_threshold" field is set

Property Value
Type	Description
`bool`

HealthyThreshold

public int HealthyThreshold { get; set; }

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Property Value
Type	Description
`int`

Http2HealthCheck

public HTTP2HealthCheck Http2HealthCheck { get; set; }

Property Value
Type	Description
`HTTP2HealthCheck`

HttpHealthCheck

public HTTPHealthCheck HttpHealthCheck { get; set; }

Property Value
Type	Description
`HTTPHealthCheck`

HttpsHealthCheck

public HTTPSHealthCheck HttpsHealthCheck { get; set; }

Property Value
Type	Description
`HTTPSHealthCheck`

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
Type	Description
`ulong`

Kind

public string Kind { get; set; }

Type of the resource.

Property Value
Type	Description
`string`

LogConfig

public HealthCheckLogConfig LogConfig { get; set; }

Configure logging on this health check.

Property Value
Type	Description
`HealthCheckLogConfig`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`string`

Region

public string Region { get; set; }

[Output Only] Region where the health check resides. Not applicable to global health checks.

Property Value
Type	Description
`string`

SelfLink

public string SelfLink { get; set; }

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

Property Value
Type	Description
`string`

SslHealthCheck

public SSLHealthCheck SslHealthCheck { get; set; }

Property Value
Type	Description
`SSLHealthCheck`

TcpHealthCheck

public TCPHealthCheck TcpHealthCheck { get; set; }

Property Value
Type	Description
`TCPHealthCheck`

TimeoutSec

public int TimeoutSec { get; set; }

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.

Property Value
Type	Description
`int`

Type

public string Type { get; set; }

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.

Property Value
Type	Description
`string`

UnhealthyThreshold

public int UnhealthyThreshold { get; set; }

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Property Value
Type	Description
`int`