GetHealthCheckResult

data class GetHealthCheckResult(val checkIntervalSec: Int, val creationTimestamp: String, val description: String, val grpcHealthCheck: GRPCHealthCheckResponse, val healthyThreshold: Int, val http2HealthCheck: HTTP2HealthCheckResponse, val httpHealthCheck: HTTPHealthCheckResponse, val httpsHealthCheck: HTTPSHealthCheckResponse, val kind: String, val logConfig: HealthCheckLogConfigResponse, val name: String, val region: String, val selfLink: String, val selfLinkWithId: String, val sourceRegions: List<String>, val sslHealthCheck: SSLHealthCheckResponse, val tcpHealthCheck: TCPHealthCheckResponse, val timeoutSec: Int, val type: String, val udpHealthCheck: UDPHealthCheckResponse, val unhealthyThreshold: Int)

Constructors

Link copied to clipboard
constructor(checkIntervalSec: Int, creationTimestamp: String, description: String, grpcHealthCheck: GRPCHealthCheckResponse, healthyThreshold: Int, http2HealthCheck: HTTP2HealthCheckResponse, httpHealthCheck: HTTPHealthCheckResponse, httpsHealthCheck: HTTPSHealthCheckResponse, kind: String, logConfig: HealthCheckLogConfigResponse, name: String, region: String, selfLink: String, selfLinkWithId: String, sourceRegions: List<String>, sslHealthCheck: SSLHealthCheckResponse, tcpHealthCheck: TCPHealthCheckResponse, timeoutSec: Int, type: String, udpHealthCheck: UDPHealthCheckResponse, unhealthyThreshold: Int)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

Creation timestamp in 3339 text format.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Type of the resource.

Link copied to clipboard

Configure logging on this health check.

Link copied to clipboard

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.

Link copied to clipboard

Region where the health check resides. Not applicable to global health checks.

Link copied to clipboard

Server-defined URL for the resource.

Link copied to clipboard

Server-defined URL for this resource with the resource id.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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