google_api_compute v0.11.0 GoogleApi.Compute.V1.Model.HealthCheck View Source
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.
Attributes
checkIntervalSec
(type:integer()
, default:nil
) - How often (in seconds) to send a health check. The default value is 5 seconds.creationTimestamp
(type:String.t
, default:nil
) - [Output Only] Creation timestamp in 3339 text format.description
(type:String.t
, default:nil
) - An optional description of this resource. Provide this property when you create the resource.healthyThreshold
(type:integer()
, default:nil
) - A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.http2HealthCheck
(type:GoogleApi.Compute.V1.Model.HTTP2HealthCheck.t
, default:nil
) -httpHealthCheck
(type:GoogleApi.Compute.V1.Model.HTTPHealthCheck.t
, default:nil
) -httpsHealthCheck
(type:GoogleApi.Compute.V1.Model.HTTPSHealthCheck.t
, default:nil
) -id
(type:String.t
, default:nil
) - [Output Only] The unique identifier for the resource. This identifier is defined by the server.kind
(type:String.t
, default:compute#healthCheck
) - Type of the resource.name
(type:String.t
, default:nil
) - 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.region
(type:String.t
, default:nil
) - [Output Only] Region where the health check resides. Not applicable to global health checks.selfLink
(type:String.t
, default:nil
) - [Output Only] Server-defined URL for the resource.sslHealthCheck
(type:GoogleApi.Compute.V1.Model.SSLHealthCheck.t
, default:nil
) -tcpHealthCheck
(type:GoogleApi.Compute.V1.Model.TCPHealthCheck.t
, default:nil
) -timeoutSec
(type:integer()
, default:nil
) - 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.type
(type:String.t
, default:nil
) - 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.unhealthyThreshold
(type:integer()
, default:nil
) - A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Sourcet() :: %GoogleApi.Compute.V1.Model.HealthCheck{ checkIntervalSec: integer(), creationTimestamp: String.t(), description: String.t(), healthyThreshold: integer(), http2HealthCheck: GoogleApi.Compute.V1.Model.HTTP2HealthCheck.t(), httpHealthCheck: GoogleApi.Compute.V1.Model.HTTPHealthCheck.t(), httpsHealthCheck: GoogleApi.Compute.V1.Model.HTTPSHealthCheck.t(), id: String.t(), kind: String.t(), name: String.t(), region: String.t(), selfLink: String.t(), sslHealthCheck: GoogleApi.Compute.V1.Model.SSLHealthCheck.t(), tcpHealthCheck: GoogleApi.Compute.V1.Model.TCPHealthCheck.t(), timeoutSec: integer(), type: String.t(), unhealthyThreshold: integer() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.