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

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

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HealthCheck

Returns a new instance of HealthCheck.



11272
11273
11274
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11272

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) 


11150
11151
11152
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11150

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) 


11155
11156
11157
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11155

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) 


11161
11162
11163
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11161

def description
  @description
end

#grpc_health_check ⇒ Google::Apis::ComputeV1::GrpcHealthCheck

Corresponds to the JSON property grpcHealthCheck

Returns:



11166
11167
11168
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11166

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


11172
11173
11174
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11172

def healthy_threshold
  @healthy_threshold
end

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

Corresponds to the JSON property http2HealthCheck

Returns:



11177
11178
11179
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11177

def http2_health_check
  @http2_health_check
end

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

Corresponds to the JSON property httpHealthCheck

Returns:



11182
11183
11184
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11182

def http_health_check
  @http_health_check
end

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

Corresponds to the JSON property httpsHealthCheck

Returns:



11187
11188
11189
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11187

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) 


11193
11194
11195
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11193

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


11198
11199
11200
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11198

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeV1::HealthCheckLogConfig

Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. Corresponds to the JSON property logConfig

Returns:



11204
11205
11206
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11204

def log_config
  @log_config
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. 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. Corresponds to the JSON property name

Returns:

  • (String) 


11215
11216
11217
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11215

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) 


11221
11222
11223
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11221

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


11226
11227
11228
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11226

def self_link
  @self_link
end

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

Returns:

  • (Array<String>) 


11240
11241
11242
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11240

def source_regions
  @source_regions
end

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

Corresponds to the JSON property sslHealthCheck

Returns:



11245
11246
11247
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11245

def ssl_health_check
  @ssl_health_check
end

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

Corresponds to the JSON property tcpHealthCheck

Returns:



11250
11251
11252
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11250

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) 


11257
11258
11259
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11257

def timeout_sec
  @timeout_sec
end

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

Returns:

  • (String) 


11264
11265
11266
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11264

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) 


11270
11271
11272
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11270

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11277

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)
  @source_regions = args[:source_regions] if args.key?(:source_regions)
  @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