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

Inherits:
Object
  • Object
show all
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, ResponseStatusCode, ServiceAgentAuthentication

Instance Attribute Summary collapse

Instance Attribute Details

#accepted_response_status_codes ⇒ ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode>

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

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#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: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.

Returns:

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#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:

  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.

Returns:

  • (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType) —

    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.


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#custom_content_type ⇒ ::String

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

Returns:

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


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:

  • (::Google::Protobuf::Map{::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.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#ping_config ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig

Returns Contains information needed to add pings to an HTTP check.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:

  • (::Integer) —

    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.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#service_agent_authentication ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication

Returns If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an Authorization header in the HTTP request when probing.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

#use_ssl ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end

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

Returns:

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'proto_docs/google/monitoring/v3/uptime.rb', line 326

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

  # A status to accept. Either a status code class like "2xx", or an integer
  # status code like "200".
  # @!attribute [rw] status_value
  #   @return [::Integer]
  #     A status code to accept.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  class ResponseStatusCode
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An HTTP status code class.
    module StatusClass
      # Default value that matches no status codes.
      STATUS_CLASS_UNSPECIFIED = 0

      # The class of status codes between 100 and 199.
      STATUS_CLASS_1XX = 100

      # The class of status codes between 200 and 299.
      STATUS_CLASS_2XX = 200

      # The class of status codes between 300 and 399.
      STATUS_CLASS_3XX = 300

      # The class of status codes between 400 and 499.
      STATUS_CLASS_4XX = 400

      # The class of status codes between 500 and 599.
      STATUS_CLASS_5XX = 500

      # The class of all status codes.
      STATUS_CLASS_ANY = 1000
    end
  end

  # Contains information needed for generating an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect).
  # The OIDC token will be generated for the Monitoring service agent service
  # account.
  # @!attribute [rw] type
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication::ServiceAgentAuthenticationType]
  #     Type of authentication.
  class ServiceAgentAuthentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Type of authentication.
    module ServiceAgentAuthenticationType
      # Default value, will result in OIDC Authentication.
      SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED = 0

      # OIDC Authentication
      OIDC_TOKEN = 1
    end
  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

    # `body` is in `custom_content_type` form. Equivalent to setting the
    # `Content-Type` to the contents of `custom_content_type` in the HTTP
    # request.
    USER_PROVIDED = 2
  end
end