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



6206
6207
6208
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6206

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) 


6836
6837
6838
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6836

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) 


6841
6842
6843
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6841

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) 


6847
6848
6849
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6847

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) 


6853
6854
6855
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6853

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) 


6154
6155
6156
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6154

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) 


6866
6867
6868
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6866

def id
  @id
end

#kind ⇒ String

Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String) 


6871
6872
6873
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6871

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) 


6881
6882
6883
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6881

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) 


6160
6161
6162
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6160

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) 


6166
6167
6168
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6166

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) 


6186
6187
6188
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6186

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) 


6192
6193
6194
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6192

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) 


6197
6198
6199
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6197

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) 


6204
6205
6206
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6204

def response
  @response
end

#self_link ⇒ String

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

Returns:

  • (String) 


6897
6898
6899
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6897

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) 


6904
6905
6906
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6904

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) 


6910
6911
6912
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6910

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6211
6212
6213
6214
6215
6216
6217
6218
6219
 
# File 'generated/google/apis/compute_v1/classes.rb', line 6211

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