Class: Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck
- Inherits:
-
Object
- Object
- Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/monitoring/v3/uptime.rb
Overview
Information involved in an HTTP/HTTPS Uptime check request.
Defined Under Namespace
Modules: ContentType, RequestMethod Classes: BasicAuthentication, HeadersEntry
Instance Attribute Summary collapse
-
#auth_info ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication
The authentication information.
-
#body ⇒ ::String
The request body associated with the HTTP POST request.
-
#content_type ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType
The content type header to use for the check.
-
#headers ⇒ ::Google::Protobuf::Map{::String => ::String}
The list of headers to send as part of the Uptime check request.
-
#mask_headers ⇒ ::Boolean
Boolean specifying whether to encrypt the header information.
-
#path ⇒ ::String
Optional (defaults to "/").
-
#port ⇒ ::Integer
Optional (defaults to 80 when
use_ssl
isfalse
, and 443 whenuse_ssl
istrue
). -
#request_method ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod
The HTTP request method to use for the check.
-
#use_ssl ⇒ ::Boolean
If
true
, use HTTPS instead of HTTP to run the check. -
#validate_ssl ⇒ ::Boolean
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.
Instance Attribute Details
permalink #auth_info ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication
Returns The authentication information. Optional when creating an HTTP check; defaults to empty.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #body ⇒ ::String
Returns 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=".
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #content_type ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType
Returns The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headers
field and thecontent_type
field. - Request method is
GET
andcontent_type
is notTYPE_UNSPECIFIED
- Request method is
POST
andcontent_type
isTYPE_UNSPECIFIED
. - Request method is
POST
and a "Content-Type" header is provided viaheaders
field. Thecontent_type
field should be used instead.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #headers ⇒ ::Google::Protobuf::Map{::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. The maximum number of headers allowed is 100.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #mask_headers ⇒ ::Boolean
Returns 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 ******.
.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #path ⇒ ::String
Returns 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.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #port ⇒ ::Integer
Returns 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.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #request_method ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod
Returns The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
then request_method
defaults to GET
.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #use_ssl ⇒ ::Boolean
Returns If true
, use HTTPS instead of HTTP to run the check.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |
permalink #validate_ssl ⇒ ::Boolean
Returns 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.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 245 class HttpCheck include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. # @!attribute [rw] username # @return [::String] # The username to use when authenticating with the HTTP server. # @!attribute [rw] password # @return [::String] # The password to use when authenticating with the HTTP server. class BasicAuthentication include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # @!attribute [rw] key # @return [::String] # @!attribute [rw] value # @return [::String] class HeadersEntry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # The HTTP request method options. module RequestMethod # No request method specified. METHOD_UNSPECIFIED = 0 # GET request. GET = 1 # POST request. POST = 2 end # Header options corresponding to the content type of a HTTP request body. module ContentType # No content type specified. TYPE_UNSPECIFIED = 0 # `body` is in URL-encoded form. Equivalent to setting the `Content-Type` # to `application/x-www-form-urlencoded` in the HTTP request. URL_ENCODED = 1 end end |