Class: Google::Apis::MonitoringV3::HttpCheck
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::HttpCheck
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/google/apis/monitoring_v3/representations.rb
Overview
Information involved in an HTTP/HTTPS Uptime check request.
Instance Attribute Summary collapse
-
#auth_info ⇒ Google::Apis::MonitoringV3::BasicAuthentication
The authentication parameters to provide to the specified resource or URL that requires a username and password.
-
#headers ⇒ Hash<String,String>
The list of headers to send as part of the Uptime check request.
-
#mask_headers ⇒ Boolean
(also: #mask_headers?)
Boolean specifiying whether to encrypt the header information.
-
#path ⇒ String
Optional (defaults to "/").
-
#port ⇒ Fixnum
Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
-
#use_ssl ⇒ Boolean
(also: #use_ssl?)
If true, use HTTPS instead of HTTP to run the check.
-
#validate_ssl ⇒ Boolean
(also: #validate_ssl?)
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpCheck
constructor
A new instance of HttpCheck.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ HttpCheck
Returns a new instance of HttpCheck.
1487 1488 1489 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1487 def initialize(**args) update!(**args) end |
Instance Attribute Details
#auth_info ⇒ Google::Apis::MonitoringV3::BasicAuthentication
The authentication parameters to provide to the specified resource or URL that
requires a username and password. Currently, only Basic HTTP authentication (
https://tools.ietf.org/html/rfc7617) is supported in Uptime checks.
Corresponds to the JSON property authInfo
1434 1435 1436 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1434 def auth_info @auth_info end |
#headers ⇒ Hash<String,String>
The list of headers to send as part of the Uptime check request. If two
headers have the same key and different values, they should be entered as a
single header, with the value being a comma-separated list of all the desired
values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page
31). Entering two separate headers with the same key in a Create call will
cause the first to be overwritten by the second. The maximum number of headers
allowed is 100.
Corresponds to the JSON property headers
1445 1446 1447 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1445 def headers @headers end |
#mask_headers ⇒ Boolean Also known as: mask_headers?
Boolean specifiying whether to encrypt the header information. Encryption
should be specified for any headers related to authentication that you do not
wish to be seen when retrieving the configuration. The server will be
responsible for encrypting the headers. On Get/List calls, if mask_headers is
set to true then the headers will be obscured with ******.
Corresponds to the JSON property maskHeaders
1454 1455 1456 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1454 def mask_headers @mask_headers end |
#path ⇒ String
Optional (defaults to "/"). The path to the page against which to run the
check. Will be combined with the host (specified within the monitored_resource)
and port to construct the full URL. If the provided path does not begin with "
/", a "/" will be prepended automatically.
Corresponds to the JSON property path
1463 1464 1465 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1463 def path @path end |
#port ⇒ Fixnum
Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
The TCP port on the HTTP server against which to run the check. Will be
combined with host (specified within the monitored_resource) and path to
construct the full URL.
Corresponds to the JSON property port
1471 1472 1473 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1471 def port @port end |
#use_ssl ⇒ Boolean Also known as: use_ssl?
If true, use HTTPS instead of HTTP to run the check.
Corresponds to the JSON property useSsl
1476 1477 1478 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1476 def use_ssl @use_ssl end |
#validate_ssl ⇒ Boolean Also known as: validate_ssl?
Boolean specifying whether to include SSL certificate validation as a part of
the Uptime check. Only applies to checks where monitored_resource is set to
uptime_url. If use_ssl is false, setting validate_ssl to true has no effect.
Corresponds to the JSON property validateSsl
1484 1485 1486 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1484 def validate_ssl @validate_ssl end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1492 1493 1494 1495 1496 1497 1498 1499 1500 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1492 def update!(**args) @auth_info = args[:auth_info] if args.key?(:auth_info) @headers = args[:headers] if args.key?(:headers) @mask_headers = args[:mask_headers] if args.key?(:mask_headers) @path = args[:path] if args.key?(:path) @port = args[:port] if args.key?(:port) @use_ssl = args[:use_ssl] if args.key?(:use_ssl) @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl) end |