Class: Google::Apis::ComputeAlpha::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.



12942
12943
12944
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12942

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) 


12810
12811
12812
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12810

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) 


12815
12816
12817
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12815

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) 


12821
12822
12823
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12821

def description
  @description
end

#grpc_health_check ⇒ Google::Apis::ComputeAlpha::GrpcHealthCheck

Corresponds to the JSON property grpcHealthCheck

Returns:



12826
12827
12828
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12826

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) 


12832
12833
12834
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12832

def healthy_threshold
  @healthy_threshold
end

#http2_health_check ⇒ Google::Apis::ComputeAlpha::Http2HealthCheck

Corresponds to the JSON property http2HealthCheck

Returns:



12837
12838
12839
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12837

def http2_health_check
  @http2_health_check
end

#http_health_check ⇒ Google::Apis::ComputeAlpha::HttpHealthCheck

Corresponds to the JSON property httpHealthCheck

Returns:



12842
12843
12844
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12842

def http_health_check
  @http_health_check
end

#https_health_check ⇒ Google::Apis::ComputeAlpha::HttpsHealthCheck

Corresponds to the JSON property httpsHealthCheck

Returns:



12847
12848
12849
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12847

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) 


12853
12854
12855
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12853

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


12858
12859
12860
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12858

def kind
  @kind
end

#log_config ⇒ Google::Apis::ComputeAlpha::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:



12864
12865
12866
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12864

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) 


12875
12876
12877
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12875

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) 


12881
12882
12883
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12881

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


12886
12887
12888
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12886

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


12891
12892
12893
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12891

def self_link_with_id
  @self_link_with_id
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 GCP 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>) 


12905
12906
12907
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12905

def source_regions
  @source_regions
end

#ssl_health_check ⇒ Google::Apis::ComputeAlpha::SslHealthCheck

Corresponds to the JSON property sslHealthCheck

Returns:



12910
12911
12912
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12910

def ssl_health_check
  @ssl_health_check
end

#tcp_health_check ⇒ Google::Apis::ComputeAlpha::TcpHealthCheck

Corresponds to the JSON property tcpHealthCheck

Returns:



12915
12916
12917
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12915

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) 


12922
12923
12924
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12922

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) 


12929
12930
12931
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12929

def type
  @type
end

#udp_health_check ⇒ Google::Apis::ComputeAlpha::UdpHealthCheck

Corresponds to the JSON property udpHealthCheck

Returns:



12934
12935
12936
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12934

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


12940
12941
12942
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12940

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12947

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