Class: Google::Apis::ComputeBeta::HttpsHealthCheck

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

Overview

An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.

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) ⇒ HttpsHealthCheck

Returns a new instance of HttpsHealthCheck



5861
5862
5863
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5861

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) 


6445
6446
6447
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6445

def check_interval_sec
  @check_interval_sec
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


6450
6451
6452
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6450

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) 


6456
6457
6458
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6456

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) 


6462
6463
6464
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6462

def healthy_threshold
  @healthy_threshold
end

#host ⇒ String

The value of the host header in the HTTPS health check request. If left empty ( default value), the public IP on behalf of which this health check is performed will be used. Corresponds to the JSON property host

Returns:

  • (String) 


5829
5830
5831
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5829

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


6475
6476
6477
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6475

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


6480
6481
6482
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6480

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


6490
6491
6492
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6490

def name
  @name
end

#port ⇒ Fixnum

The TCP port number for the HTTPS health check request. The default value is 443. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


5835
5836
5837
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5835

def port
  @port
end

#port_name ⇒ String

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Corresponds to the JSON property portName

Returns:

  • (String) 


5841
5842
5843
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5841

def port_name
  @port_name
end

#proxy_header ⇒ String

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Corresponds to the JSON property proxyHeader

Returns:

  • (String) 


5847
5848
5849
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5847

def proxy_header
  @proxy_header
end

#request_path ⇒ String

The request path of the HTTPS health check request. The default value is "/". Corresponds to the JSON property requestPath

Returns:

  • (String) 


5852
5853
5854
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5852

def request_path
  @request_path
end

#response ⇒ String

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. Corresponds to the JSON property response

Returns:

  • (String) 


5859
5860
5861
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5859

def response
  @response
end

#self_link ⇒ String

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

Returns:

  • (String) 


6506
6507
6508
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6506

def self_link
  @self_link
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 a greater value than checkIntervalSec. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum) 


6513
6514
6515
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6513

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


6519
6520
6521
 
# File 'generated/google/apis/compute_beta/classes.rb', line 6519

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5866
5867
5868
5869
5870
5871
5872
5873
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5866

def update!(**args)
  @host = args[:host] if args.key?(:host)
  @port = args[:port] if args.key?(:port)
  @port_name = args[:port_name] if args.key?(:port_name)
  @proxy_header = args[:proxy_header] if args.key?(:proxy_header)
  @request_path = args[:request_path] if args.key?(:request_path)
  @response = args[:response] if args.key?(:response)
end