Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::HealthCheck (v3.5.0)

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:

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, seeHealth 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. [Output Only] Creation timestamp in3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp in3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp in3339 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
Returns

#grpc_health_check=

def grpc_health_check=(value) -> ::Google::Cloud::Compute::V1::GRPCHealthCheck
Parameter
Returns

#grpc_tls_health_check

def grpc_tls_health_check() -> ::Google::Cloud::Compute::V1::GRPCTLSHealthCheck
Returns

#grpc_tls_health_check=

def grpc_tls_health_check=(value) -> ::Google::Cloud::Compute::V1::GRPCTLSHealthCheck
Parameter
Returns

#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
Returns

#http2_health_check=

def http2_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTP2HealthCheck
Parameter
Returns

#http_health_check

def http_health_check() -> ::Google::Cloud::Compute::V1::HTTPHealthCheck
Returns

#http_health_check=

def http_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTPHealthCheck
Parameter
Returns

#https_health_check

def https_health_check() -> ::Google::Cloud::Compute::V1::HTTPSHealthCheck
Returns

#https_health_check=

def https_health_check=(value) -> ::Google::Cloud::Compute::V1::HTTPSHealthCheck
Parameter
Returns

#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) — Output only. Type of the resource.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. Type of the resource.
Returns
  • (::String) — Output only. Type of the resource.

#log_config

def log_config() -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
Returns

#log_config=

def log_config=(value) -> ::Google::Cloud::Compute::V1::HealthCheckLogConfig
Parameter
Returns

#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 withRFC1035. 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 withRFC1035. 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 withRFC1035. 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. [Output Only] Region where the health check resides. Not applicable to global health checks.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Region where the health check resides. Not applicable to global health checks.
Returns
  • (::String) — Output only. [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.

#source_regions

def source_regions() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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 Google Cloud 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.

#source_regions=

def source_regions=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    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 Google Cloud 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.
Returns
  • (::Array<::String>) —

    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 Google Cloud 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.

#ssl_health_check

def ssl_health_check() -> ::Google::Cloud::Compute::V1::SSLHealthCheck
Returns

#ssl_health_check=

def ssl_health_check=(value) -> ::Google::Cloud::Compute::V1::SSLHealthCheck
Parameter
Returns

#tcp_health_check

def tcp_health_check() -> ::Google::Cloud::Compute::V1::TCPHealthCheck
Returns

#tcp_health_check=

def tcp_health_check=(value) -> ::Google::Cloud::Compute::V1::TCPHealthCheck
Parameter
Returns

#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 matchtype 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 matchtype 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 matchtype 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.