Class: Google::Apis::ComputeV1::HttpsHealthCheck
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::HttpsHealthCheck
- Defined in:
- generated/google/apis/compute_v1/classes.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
-
#check_interval_sec ⇒ Fixnum
How often (in seconds) to send a health check.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#healthy_threshold ⇒ Fixnum
A so-far unhealthy instance will be marked healthy after this many consecutive successes.
-
#host ⇒ String
The value of the host header in the HTTPS health check request.
-
#id ⇒ String
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#port ⇒ Fixnum
The TCP port number for the HTTPS health check request.
-
#request_path ⇒ String
The request path of the HTTPS health check request.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#timeout_sec ⇒ Fixnum
How long (in seconds) to wait before claiming failure.
-
#unhealthy_threshold ⇒ Fixnum
A so-far healthy instance will be marked unhealthy after this many consecutive failures.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpsHealthCheck
constructor
A new instance of HttpsHealthCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ HttpsHealthCheck
Returns a new instance of HttpsHealthCheck.
2880 2881 2882 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2880 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
2804 2805 2806 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2804 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
2809 2810 2811 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2809 def @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
2815 2816 2817 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2815 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
2821 2822 2823 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2821 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
2828 2829 2830 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2828 def host @host end |
#id ⇒ String
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
2834 2835 2836 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2834 def id @id end |
#kind ⇒ String
Type of the resource.
Corresponds to the JSON property kind
2839 2840 2841 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2839 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
2849 2850 2851 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2849 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
2855 2856 2857 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2855 def port @port end |
#request_path ⇒ String
The request path of the HTTPS health check request. The default value is "/".
Corresponds to the JSON property requestPath
2860 2861 2862 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2860 def request_path @request_path end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
2865 2866 2867 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2865 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
2872 2873 2874 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2872 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
2878 2879 2880 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2878 def unhealthy_threshold @unhealthy_threshold end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 |
# File 'generated/google/apis/compute_v1/classes.rb', line 2885 def update!(**args) @check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold) @host = args[:host] if args.key?(:host) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @port = args[:port] if args.key?(:port) @request_path = args[:request_path] if args.key?(:request_path) @self_link = args[:self_link] if args.key?(:self_link) @timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec) @unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold) end |