Class: Google::Apis::ComputeV1::HttpHealthCheck

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 HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.

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

Returns a new instance of HttpHealthCheck.


2678
2679
2680
# File 'generated/google/apis/compute_v1/classes.rb', line 2678

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#check_interval_secFixnum

How often (in seconds) to send a health check. The default value is 5 seconds. Corresponds to the JSON property checkIntervalSec

Returns:

  • (Fixnum)

3016
3017
3018
# File 'generated/google/apis/compute_v1/classes.rb', line 3016

def check_interval_sec
  @check_interval_sec
end

#creation_timestampString

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

Returns:

  • (String)

3021
3022
3023
# File 'generated/google/apis/compute_v1/classes.rb', line 3021

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)

3027
3028
3029
# File 'generated/google/apis/compute_v1/classes.rb', line 3027

def description
  @description
end

#healthy_thresholdFixnum

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)

3033
3034
3035
# File 'generated/google/apis/compute_v1/classes.rb', line 3033

def healthy_threshold
  @healthy_threshold
end

#hostString

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)

2654
2655
2656
# File 'generated/google/apis/compute_v1/classes.rb', line 2654

def host
  @host
end

#idString

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (String)

3046
3047
3048
# File 'generated/google/apis/compute_v1/classes.rb', line 3046

def id
  @id
end

#kindString

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

Returns:

  • (String)

3052
3053
3054
# File 'generated/google/apis/compute_v1/classes.rb', line 3052

def kind
  @kind
end

#nameString

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)

3062
3063
3064
# File 'generated/google/apis/compute_v1/classes.rb', line 3062

def name
  @name
end

#portFixnum

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

Returns:

  • (Fixnum)

2659
2660
2661
# File 'generated/google/apis/compute_v1/classes.rb', line 2659

def port
  @port
end

#port_nameString

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)

2665
2666
2667
# File 'generated/google/apis/compute_v1/classes.rb', line 2665

def port_name
  @port_name
end

#proxy_headerString

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)

2671
2672
2673
# File 'generated/google/apis/compute_v1/classes.rb', line 2671

def proxy_header
  @proxy_header
end

#request_pathString

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

Returns:

  • (String)

2676
2677
2678
# File 'generated/google/apis/compute_v1/classes.rb', line 2676

def request_path
  @request_path
end

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

Returns:

  • (String)

3077
3078
3079
# File 'generated/google/apis/compute_v1/classes.rb', line 3077

def self_link
  @self_link
end

#timeout_secFixnum

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)

3084
3085
3086
# File 'generated/google/apis/compute_v1/classes.rb', line 3084

def timeout_sec
  @timeout_sec
end

#unhealthy_thresholdFixnum

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)

3090
3091
3092
# File 'generated/google/apis/compute_v1/classes.rb', line 3090

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2683
2684
2685
2686
2687
2688
2689
# File 'generated/google/apis/compute_v1/classes.rb', line 2683

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