Class: Google::Apis::MonitoringV3::HttpCheck
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::HttpCheck
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb
Overview
Information involved in an HTTP/HTTPS Uptime check request.
Instance Attribute Summary collapse
-
#accepted_response_status_codes ⇒ Array<Google::Apis::MonitoringV3::ResponseStatusCode>
If present, the check will only pass if the HTTP response status code is in this set of status codes.
-
#auth_info ⇒ Google::Apis::MonitoringV3::BasicAuthentication
The authentication parameters to provide to the specified resource or URL that requires a username and password.
-
#body ⇒ String
The request body associated with the HTTP POST request.
-
#content_type ⇒ String
The content type header to use for the check.
-
#custom_content_type ⇒ String
A user provided content type header to use for the check.
-
#headers ⇒ Hash<String,String>
The list of headers to send as part of the Uptime check request.
-
#mask_headers ⇒ Boolean
(also: #mask_headers?)
Boolean specifying whether to encrypt the header information.
-
#path ⇒ String
Optional (defaults to "/").
-
#ping_config ⇒ Google::Apis::MonitoringV3::PingConfig
Information involved in sending ICMP pings alongside public HTTP/TCP checks.
-
#port ⇒ Fixnum
Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
-
#request_method ⇒ String
The HTTP request method to use for the check.
-
#service_agent_authentication ⇒ Google::Apis::MonitoringV3::ServiceAgentAuthentication
Contains information needed for generating either an OpenID Connect token ( https://developers.google.com/identity/protocols/OpenIDConnect) or OAuth token (https://developers.google.com/identity/protocols/oauth2).
-
#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.
Constructor Details
#initialize(**args) ⇒ HttpCheck
Returns a new instance of HttpCheck.
2053 2054 2055 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2053 def initialize(**args) update!(**args) end |
Instance Attribute Details
#accepted_response_status_codes ⇒ Array<Google::Apis::MonitoringV3::ResponseStatusCode>
If present, the check will only pass if the HTTP response status code is in
this set of status codes. If empty, the HTTP status code will only pass if the
HTTP status code is 200-299.
Corresponds to the JSON property acceptedResponseStatusCodes
1942 1943 1944 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1942 def accepted_response_status_codes @accepted_response_status_codes end |
#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
1949 1950 1951 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1949 def auth_info @auth_info end |
#body ⇒ String
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: If client libraries aren't used (which
performs the conversion automatically) base64 encode your body data since the
field is of bytes type.
Corresponds to the JSON property body
NOTE: Values are automatically base64 encoded/decoded in the client library.
1961 1962 1963 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1961 def body @body end |
#content_type ⇒ 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
1971 1972 1973 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1971 def content_type @content_type end |
#custom_content_type ⇒ String
A user provided content type header to use for the check. The invalid
configurations outlined in the content_type field apply to custom_content_type,
as well as the following: 1. content_type is URL_ENCODED and
custom_content_type is set. 2. content_type is USER_PROVIDED and
custom_content_type is not set.
Corresponds to the JSON property customContentType
1980 1981 1982 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1980 def custom_content_type @custom_content_type 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
1991 1992 1993 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1991 def headers @headers end |
#mask_headers ⇒ Boolean Also known as: mask_headers?
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
2000 2001 2002 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2000 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
2009 2010 2011 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2009 def path @path end |
#ping_config ⇒ Google::Apis::MonitoringV3::PingConfig
Information involved in sending ICMP pings alongside public HTTP/TCP checks.
For HTTP, the pings are performed for each part of the redirect chain.
Corresponds to the JSON property pingConfig
2015 2016 2017 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2015 def ping_config @ping_config 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
2023 2024 2025 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2023 def port @port end |
#request_method ⇒ String
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
2029 2030 2031 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2029 def request_method @request_method end |
#service_agent_authentication ⇒ Google::Apis::MonitoringV3::ServiceAgentAuthentication
Contains information needed for generating either an OpenID Connect token (
https://developers.google.com/identity/protocols/OpenIDConnect) or OAuth token
(https://developers.google.com/identity/protocols/oauth2). The token will be
generated for the Monitoring service agent service account.
Corresponds to the JSON property serviceAgentAuthentication
2037 2038 2039 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2037 def service_agent_authentication @service_agent_authentication 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
2042 2043 2044 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2042 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
2050 2051 2052 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2050 def validate_ssl @validate_ssl end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 |
# File 'lib/google/apis/monitoring_v3/classes.rb', line 2058 def update!(**args) @accepted_response_status_codes = args[:accepted_response_status_codes] if args.key?(:accepted_response_status_codes) @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) @custom_content_type = args[:custom_content_type] if args.key?(:custom_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) @ping_config = args[:ping_config] if args.key?(:ping_config) @port = args[:port] if args.key?(:port) @request_method = args[:request_method] if args.key?(:request_method) @service_agent_authentication = args[:service_agent_authentication] if args.key?(:service_agent_authentication) @use_ssl = args[:use_ssl] if args.key?(:use_ssl) @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl) end |