Class: Google::Apis::ComputeBeta::HealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/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). Network load balancers must use legacy HTTP health checks (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.



9649
9650
9651
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9649

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) 


9542
9543
9544
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9542

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) 


9547
9548
9549
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9547

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) 


9553
9554
9555
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9553

def description
  @description
end

#grpc_health_check ⇒ Google::Apis::ComputeBeta::GrpcHealthCheck

Corresponds to the JSON property grpcHealthCheck

Returns:



9558
9559
9560
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9558

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) 


9564
9565
9566
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9564

def healthy_threshold
  @healthy_threshold
end

#http2_health_check ⇒ Google::Apis::ComputeBeta::Http2HealthCheck

Corresponds to the JSON property http2HealthCheck

Returns:



9569
9570
9571
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9569

def http2_health_check
  @http2_health_check
end

#http_health_check ⇒ Google::Apis::ComputeBeta::HttpHealthCheck

Corresponds to the JSON property httpHealthCheck

Returns:



9574
9575
9576
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9574

def http_health_check
  @http_health_check
end

#https_health_check ⇒ Google::Apis::ComputeBeta::HttpsHealthCheck

Corresponds to the JSON property httpsHealthCheck

Returns:



9579
9580
9581
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9579

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) 


9585
9586
9587
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9585

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


9590
9591
9592
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9590

def kind
  @kind
end

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



9596
9597
9598
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9596

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


9606
9607
9608
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9606

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) 


9612
9613
9614
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9612

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


9617
9618
9619
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9617

def self_link
  @self_link
end

#ssl_health_check ⇒ Google::Apis::ComputeBeta::SslHealthCheck

Corresponds to the JSON property sslHealthCheck

Returns:



9622
9623
9624
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9622

def ssl_health_check
  @ssl_health_check
end

#tcp_health_check ⇒ Google::Apis::ComputeBeta::TcpHealthCheck

Corresponds to the JSON property tcpHealthCheck

Returns:



9627
9628
9629
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9627

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) 


9634
9635
9636
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9634

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) 


9641
9642
9643
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9641

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) 


9647
9648
9649
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9647

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
 
# File 'lib/google/apis/compute_beta/classes.rb', line 9654

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