Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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 Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. 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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#check_interval_sec
def check_interval_sec() -> ::Integer
- (::Integer) — How often (in seconds) to send a health check. The default value is 5 seconds.
#check_interval_sec=
def check_interval_sec=(value) -> ::Integer
- value (::Integer) — How often (in seconds) to send a health check. The default value is 5 seconds.
- (::Integer) — How often (in seconds) to send a health check. The default value is 5 seconds.
#creation_timestamp
def creation_timestamp() -> ::String
- (::String) — [Output Only] Creation timestamp in 3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String
- value (::String) — [Output Only] Creation timestamp in 3339 text format.
- (::String) — [Output Only] Creation timestamp in 3339 text format.
#description
def description() -> ::String
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#grpc_health_check
def grpc_health_check() -> ::Google::Cloud::Compute::V1::GRPCHealthCheck
#grpc_health_check=
def grpc_health_check=(value) -> ::Google::Cloud::Compute::V1::GRPCHealthCheck
#healthy_threshold
def healthy_threshold() -> ::Integer
- (::Integer) — A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
#healthy_threshold=
def healthy_threshold=(value) -> ::Integer
- value (::Integer) — A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
- (::Integer) — A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
#http2_health_check
def http2_health_check() -> ::Google::Cloud::Compute::V1::HTTP2HealthCheck
#http2_health_check=
def http2_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTP2HealthCheck
#http_health_check
def http_health_check() -> ::Google::Cloud::Compute::V1::HTTPHealthCheck
#http_health_check=
def http_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTPHealthCheck
#https_health_check
def https_health_check() -> ::Google::Cloud::Compute::V1::HTTPSHealthCheck
#https_health_check=
def https_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTPSHealthCheck
#id
def id() -> ::Integer
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#id=
def id=(value) -> ::Integer
- value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#kind
def kind() -> ::String
- (::String) — Type of the resource.
#kind=
def kind=(value) -> ::String
- value (::String) — Type of the resource.
- (::String) — Type of the resource.
#log_config
def log_config() -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
- (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
#log_config=
def log_config=(value) -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
- value (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
- (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
#name
def name() -> ::String
-
(::String) — 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.
#name=
def name=(value) -> ::String
-
value (::String) — 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.
-
(::String) — 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.
#region
def region() -> ::String
- (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
#region=
def region=(value) -> ::String
- value (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
- (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
#self_link
def self_link() -> ::String
- (::String) — [Output Only] Server-defined URL for the resource.
#self_link=
def self_link=(value) -> ::String
- value (::String) — [Output Only] Server-defined URL for the resource.
- (::String) — [Output Only] Server-defined URL for the resource.
#ssl_health_check
def ssl_health_check() -> ::Google::Cloud::Compute::V1::SSLHealthCheck
#ssl_health_check=
def ssl_health_check=(value) -> ::Google::Cloud::Compute::V1::SSLHealthCheck
#tcp_health_check
def tcp_health_check() -> ::Google::Cloud::Compute::V1::TCPHealthCheck
#tcp_health_check=
def tcp_health_check=(value) -> ::Google::Cloud::Compute::V1::TCPHealthCheck
#timeout_sec
def timeout_sec() -> ::Integer
- (::Integer) — 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.
#timeout_sec=
def timeout_sec=(value) -> ::Integer
- value (::Integer) — 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.
- (::Integer) — 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
def type() -> ::String
- (::String) — 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.
#type=
def type=(value) -> ::String
- value (::String) — 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.
- (::String) — 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.
#unhealthy_threshold
def unhealthy_threshold() -> ::Integer
- (::Integer) — A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
#unhealthy_threshold=
def unhealthy_threshold=(value) -> ::Integer
- value (::Integer) — A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
- (::Integer) — A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.