class Google::Apis::MonitoringV3::HttpCheck
Information involved in an HTTP/HTTPS Uptime check request.
Attributes
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication ( tools.ietf.org/html/rfc7617) is supported in Uptime checks. Corresponds to the JSON property `authInfo` @return [Google::Apis::MonitoringV3::BasicAuthentication]
The request body associated with the HTTP POST request. If content_type
is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method
is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: “foo=bar” in URL-encoded form is “ foo%3Dbar” and in base64 encoding is “Zm9vJTI1M0RiYXI=”. Corresponds to the JSON property `body` NOTE: Values are automatically base64 encoded/decoded in the client library. @return [String]
The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type
field. 2. Request method is GET and content_type
is not TYPE_UNSPECIFIED 3. Request method is POST and content_type
is TYPE_UNSPECIFIED. 4. Request method is POST and a “Content-Type” header is provided via headers field. The content_type
field should be used instead. Corresponds to the JSON property `contentType` @return [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 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` @return [Hash<String,String>]
Boolean specifying 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` @return [Boolean]
Boolean specifying 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` @return [Boolean]
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` @return [String]
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` @return [Fixnum]
The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method
defaults to GET. Corresponds to the JSON property `requestMethod` @return [String]
If true, use HTTPS instead of HTTP to run the check. Corresponds to the JSON property `useSsl` @return [Boolean]
If true, use HTTPS instead of HTTP to run the check. Corresponds to the JSON property `useSsl` @return [Boolean]
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` @return [Boolean]
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` @return [Boolean]
Public Class Methods
# File lib/google/apis/monitoring_v3/classes.rb, line 1557 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/monitoring_v3/classes.rb, line 1562 def update!(**args) @auth_info = args[:auth_info] if args.key?(:auth_info) @body = args[:body] if args.key?(:body) @content_type = args[:content_type] if args.key?(:content_type) @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) @request_method = args[:request_method] if args.key?(:request_method) @use_ssl = args[:use_ssl] if args.key?(:use_ssl) @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl) end