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: * Global * Regional Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks). Traffic Director must use global health checks (compute.v1.HealthChecks). Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks or compute.v1.HealthChecks). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.HealthChecks). Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks). Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks). 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
Returns
- (::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
Parameter
- value (::Integer) — How often (in seconds) to send a health check. The default value is 5 seconds.
Returns
- (::Integer) — How often (in seconds) to send a health check. The default value is 5 seconds.
#creation_timestamp
def creation_timestamp() -> ::String
Returns
- (::String) — [Output Only] Creation timestamp in 3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String
Parameter
- value (::String) — [Output Only] Creation timestamp in 3339 text format.
Returns
- (::String) — [Output Only] Creation timestamp in 3339 text format.
#description
def description() -> ::String
Returns
- (::String) — An optional description of this resource. Provide this property when you create the resource.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
- (::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
Parameter
#healthy_threshold
def healthy_threshold() -> ::Integer
Returns
- (::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
Parameter
- value (::Integer) — A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Returns
- (::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
Parameter
#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
Parameter
#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
Parameter
#id
def id() -> ::Integer
Returns
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#id=
def id=(value) -> ::Integer
Parameter
- value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#kind
def kind() -> ::String
Returns
- (::String) — Type of the resource.
#kind=
def kind=(value) -> ::String
Parameter
- value (::String) — Type of the resource.
Returns
- (::String) — Type of the resource.
#log_config
def log_config() -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
Returns
- (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
#log_config=
def log_config=(value) -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
Parameter
- value (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
Returns
- (::Google::Cloud::Compute::V1::HealthCheckLogConfig) — Configure logging on this health check.
#name
def name() -> ::String
Returns
-
(::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
Parameter
-
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.
Returns
-
(::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
Returns
- (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
#region=
def region=(value) -> ::String
Parameter
- value (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
Returns
- (::String) — [Output Only] Region where the health check resides. Not applicable to global health checks.
#self_link
def self_link() -> ::String
Returns
- (::String) — [Output Only] Server-defined URL for the resource.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — [Output Only] Server-defined URL for the resource.
Returns
- (::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
Parameter
#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
Parameter
#timeout_sec
def timeout_sec() -> ::Integer
Returns
- (::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
Parameter
- 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.
Returns
- (::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
Returns
- (::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
Parameter
- 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.
Returns
- (::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
Returns
- (::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
Parameter
- value (::Integer) — A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
Returns
- (::Integer) — A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.