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: * Global * Regional 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HealthCheck

Returns a new instance of HealthCheck.



11086
11087
11088
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11086

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) 


10968
10969
10970
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10968

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) 


10973
10974
10975
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10973

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) 


10979
10980
10981
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10979

def description
  @description
end

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

Corresponds to the JSON property grpcHealthCheck

Returns:



10984
10985
10986
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10984

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) 


10990
10991
10992
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10990

def healthy_threshold
  @healthy_threshold
end

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

Corresponds to the JSON property http2HealthCheck

Returns:



10995
10996
10997
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10995

def http2_health_check
  @http2_health_check
end

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

Corresponds to the JSON property httpHealthCheck

Returns:



11000
11001
11002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11000

def http_health_check
  @http_health_check
end

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

Corresponds to the JSON property httpsHealthCheck

Returns:



11005
11006
11007
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11005

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) 


11011
11012
11013
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11011

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


11016
11017
11018
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11016

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:



11022
11023
11024
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11022

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) 


11033
11034
11035
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11033

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) 


11039
11040
11041
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11039

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


11044
11045
11046
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11044

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) 


11049
11050
11051
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11049

def self_link_with_id
  @self_link_with_id
end

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

Corresponds to the JSON property sslHealthCheck

Returns:



11054
11055
11056
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11054

def ssl_health_check
  @ssl_health_check
end

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

Corresponds to the JSON property tcpHealthCheck

Returns:



11059
11060
11061
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11059

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) 


11066
11067
11068
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11066

def timeout_sec
  @timeout_sec
end

#type ⇒ String

Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. 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) 


11073
11074
11075
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11073

def type
  @type
end

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

Corresponds to the JSON property udpHealthCheck

Returns:



11078
11079
11080
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11078

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) 


11084
11085
11086
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11084

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11091

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