Class: Google::Apis::ComputeV1::HttpsHealthCheck

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



6507
6508
6509
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6507

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) 


7137
7138
7139
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7137

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) 


7142
7143
7144
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7142

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) 


7148
7149
7150
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7148

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) 


7154
7155
7156
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7154

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) 


6455
6456
6457
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6455

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) 


7167
7168
7169
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7167

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


7172
7173
7174
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7172

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]([-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) 


7182
7183
7184
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7182

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) 


6461
6462
6463
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6461

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) 


6467
6468
6469
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6467

def port_name
  @port_name
end

#port_specification ⇒ String

Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTPS health check follows behavior specified in port and portName fields. Corresponds to the JSON property portSpecification

Returns:

  • (String) 


6487
6488
6489
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6487

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


6493
6494
6495
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6493

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) 


6498
6499
6500
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6498

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) 


6505
6506
6507
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6505

def response
  @response
end

#self_link ⇒ String

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

Returns:

  • (String) 


7198
7199
7200
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7198

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) 


7205
7206
7207
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7205

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) 


7211
7212
7213
 
# File 'generated/google/apis/compute_v1/classes.rb', line 7211

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6512
6513
6514
6515
6516
6517
6518
6519
6520
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6512

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