class Google::Apis::ComputeV1::HealthCheck

Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [ Regional](/compute/docs/reference/rest/v1/regionHealthChecks) 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.

Attributes

check_interval_sec[RW]

How often (in seconds) to send a health check. The default value is 5 seconds. Corresponds to the JSON property `checkIntervalSec` @return [Fixnum]

creation_timestamp[RW]
Output Only

Creation timestamp in 3339 text format.

Corresponds to the JSON property `creationTimestamp` @return [String]

description[RW]

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]

grpc_health_check[RW]

Corresponds to the JSON property `grpcHealthCheck` @return [Google::Apis::ComputeV1::GrpcHealthCheck]

healthy_threshold[RW]

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. Corresponds to the JSON property `healthyThreshold` @return [Fixnum]

http2_health_check[RW]

Corresponds to the JSON property `http2HealthCheck` @return [Google::Apis::ComputeV1::Http2HealthCheck]

http_health_check[RW]

Corresponds to the JSON property `httpHealthCheck` @return [Google::Apis::ComputeV1::HttpHealthCheck]

https_health_check[RW]

Corresponds to the JSON property `httpsHealthCheck` @return [Google::Apis::ComputeV1::HttpsHealthCheck]

id[RW]
Output Only

The unique identifier for the resource. This identifier is

defined by the server. Corresponds to the JSON property `id` @return [Fixnum]

kind[RW]

Type of the resource. Corresponds to the JSON property `kind` @return [String]

log_config[RW]

Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. Corresponds to the JSON property `logConfig` @return [Google::Apis::ComputeV1::HealthCheckLogConfig]

name[RW]

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]*)?`, 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. Corresponds to the JSON property `name` @return [String]

region[RW]
Output Only

Region where the health check resides. Not applicable to global

health checks. Corresponds to the JSON property `region` @return [String]

ssl_health_check[RW]

Corresponds to the JSON property `sslHealthCheck` @return [Google::Apis::ComputeV1::SslHealthCheck]

tcp_health_check[RW]

Corresponds to the JSON property `tcpHealthCheck` @return [Google::Apis::ComputeV1::TcpHealthCheck]

timeout_sec[RW]

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. Corresponds to the JSON property `timeoutSec` @return [Fixnum]

type[RW]

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. Corresponds to the JSON property `type` @return [String]

unhealthy_threshold[RW]

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. Corresponds to the JSON property `unhealthyThreshold` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/compute_v1/classes.rb, line 9231
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/compute_v1/classes.rb, line 9236
def update!(**args)
  @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @grpc_health_check = args[:grpc_health_check] if args.key?(:grpc_health_check)
  @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold)
  @http2_health_check = args[:http2_health_check] if args.key?(:http2_health_check)
  @http_health_check = args[:http_health_check] if args.key?(:http_health_check)
  @https_health_check = args[:https_health_check] if args.key?(:https_health_check)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @log_config = args[:log_config] if args.key?(:log_config)
  @name = args[:name] if args.key?(:name)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @ssl_health_check = args[:ssl_health_check] if args.key?(:ssl_health_check)
  @tcp_health_check = args[:tcp_health_check] if args.key?(:tcp_health_check)
  @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
  @type = args[:type] if args.key?(:type)
  @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold)
end