Class: Google::Monitoring::V3::UptimeCheckConfig::HttpCheck

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb

Overview

Information involved in an HTTP/HTTPS uptime check request.

Defined Under Namespace

Classes: BasicAuthentication

Instance Attribute Summary collapse

Instance Attribute Details

#auth_info ⇒ Google::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication

Returns The authentication information. Optional when creating an HTTP check; defaults to empty.

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end

#headers ⇒ Hash{String => String}

Returns 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.

Returns:

  • (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.



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end

#mask_headers ⇒ true, false

Returns 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 ******.

Returns:

  • (true, false) —

    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 ******.



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end

#path ⇒ String

Returns The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").

Returns:

  • (String) —

    The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end

#port ⇒ Integer

Returns The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).

Returns:

  • (Integer) —

    The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end

#use_ssl ⇒ true, false

Returns If true, use HTTPS instead of HTTP to run the check.

Returns:

  • (true, false) —

    If true, use HTTPS instead of HTTP to run the check.



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb', line 119

class HttpCheck
  # A type of authentication to perform against the specified resource or URL
  # that uses username and password.
  # Currently, only Basic authentication is supported in Uptime Monitoring.
  # @!attribute [rw] username
  #   @return [String]
  #     The username to authenticate.
  # @!attribute [rw] password
  #   @return [String]
  #     The password to authenticate.
  class BasicAuthentication; end
end