Class: Google::Apis::ComputeAlpha::HttpHealthCheck

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/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpHealthCheck

Returns a new instance of HttpHealthCheck.



10186
10187
10188
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10186

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) 


11772
11773
11774
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11772

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) 


11777
11778
11779
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11777

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) 


11783
11784
11785
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11783

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) 


11789
11790
11791
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11789

def healthy_threshold
  @healthy_threshold
end

#host ⇒ String

The value of the host header in the HTTP 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) 


10141
10142
10143
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10141

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) 


11802
11803
11804
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11802

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. Corresponds to the JSON property kind

Returns:

  • (String) 


11808
11809
11810
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11808

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) 


11818
11819
11820
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11818

def name
  @name
end

#port ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10147
10148
10149
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10147

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) 


10153
10154
10155
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10153

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, HTTP health check follows behavior specified in port and portName fields. Corresponds to the JSON property portSpecification

Returns:

  • (String) 


10166
10167
10168
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10166

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) 


10172
10173
10174
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10172

def proxy_header
  @proxy_header
end

#request_path ⇒ String

The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Corresponds to the JSON property requestPath

Returns:

  • (String) 


10177
10178
10179
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10177

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) 


10184
10185
10186
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10184

def response
  @response
end

#self_link ⇒ String

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

Returns:

  • (String) 


11834
11835
11836
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11834

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) 


11839
11840
11841
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11839

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


11846
11847
11848
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11846

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) 


11852
11853
11854
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11852

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10191
10192
10193
10194
10195
10196
10197
10198
10199
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10191

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