Class: Google::Apis::ComputeV1::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HealthCheck

Returns a new instance of HealthCheck



7284
7285
7286
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7284

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#check_interval_sec ⇒ Fixnum

How often (in seconds) to send a health check. The default value is 5 seconds. Corresponds to the JSON property checkIntervalSec

Returns:

  • (Fixnum) 


7188
7189
7190
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7188

def check_interval_sec
  @check_interval_sec
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in 3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


7193
7194
7195
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7193

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


7199
7200
7201
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7199

def description
  @description
end

#healthy_threshold ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7205
7206
7207
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7205

def healthy_threshold
  @healthy_threshold
end

#http2_health_check ⇒ Google::Apis::ComputeV1::Http2HealthCheck

Corresponds to the JSON property http2HealthCheck

Returns:



7210
7211
7212
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7210

def http2_health_check
  @http2_health_check
end

#http_health_check ⇒ Google::Apis::ComputeV1::HttpHealthCheck

Corresponds to the JSON property httpHealthCheck

Returns:



7215
7216
7217
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7215

def http_health_check
  @http_health_check
end

#https_health_check ⇒ Google::Apis::ComputeV1::HttpsHealthCheck

Corresponds to the JSON property httpsHealthCheck

Returns:



7220
7221
7222
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7220

def https_health_check
  @https_health_check
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


7226
7227
7228
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7226

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


7231
7232
7233
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7231

def kind
  @kind
end

#name ⇒ 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. 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. Corresponds to the JSON property name

Returns:

  • (String) 


7241
7242
7243
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7241

def name
  @name
end

#region ⇒ String

[Output Only] Region where the health check resides. Not applicable to global health checks. Corresponds to the JSON property region

Returns:

  • (String) 


7247
7248
7249
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7247

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


7252
7253
7254
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7252

def self_link
  @self_link
end

#ssl_health_check ⇒ Google::Apis::ComputeV1::SslHealthCheck

Corresponds to the JSON property sslHealthCheck

Returns:



7257
7258
7259
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7257

def ssl_health_check
  @ssl_health_check
end

#tcp_health_check ⇒ Google::Apis::ComputeV1::TcpHealthCheck

Corresponds to the JSON property tcpHealthCheck

Returns:



7262
7263
7264
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7262

def tcp_health_check
  @tcp_health_check
end

#timeout_sec ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7269
7270
7271
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7269

def timeout_sec
  @timeout_sec
end

#type ⇒ String

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

Returns:

  • (String) 


7276
7277
7278
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7276

def type
  @type
end

#unhealthy_threshold ⇒ Fixnum

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

Returns:

  • (Fixnum) 


7282
7283
7284
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7282

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7289

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)
  @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)
  @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