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

Inherits:

Object

Object
Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck

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

#accepted_response_status_codes ⇒ ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode>
If present, the check will only pass if the HTTP response status code is in this set of status codes.
#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.
#custom_content_type ⇒ ::String
A user provided 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 "/").
#ping_config ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig
Contains information needed to add pings to an HTTP check.
#port ⇒ ::Integer
Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
#request_method ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod
The HTTP request method to use for the check.
#service_agent_authentication ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication
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.
#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

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

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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}`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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`

# File 'proto_docs/google/monitoring/v3/uptime.rb', line 336

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.
  #
  #     Note: The following fields are mutually exclusive: `status_value`, `status_class`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] status_class
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode::StatusClass]
  #     A class of status codes to accept.
  #
  #     Note: The following fields are mutually exclusive: `status_class`, `status_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  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 either an
  # [OpenID Connect
  # token](https://developers.google.com/identity/protocols/OpenIDConnect) or
  # [OAuth token](https://developers.google.com/identity/protocols/oauth2).
  # The token will be generated for the Monitoring service agent service
  # account.
  # @!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

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

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

#body ⇒ ::String

#content_type ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType

#custom_content_type ⇒ ::String

#headers ⇒ ::Google::Protobuf::Map{::String => ::String}

#mask_headers ⇒ ::Boolean

#path ⇒ ::String

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

#port ⇒ ::Integer

#request_method ⇒ ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod

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

#use_ssl ⇒ ::Boolean

#validate_ssl ⇒ ::Boolean

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

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

#body ⇒ `::String`

#content_type ⇒ `::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType`

#custom_content_type ⇒ `::String`

#headers ⇒ `::Google::Protobuf::Map{::String => ::String}`

#mask_headers ⇒ `::Boolean`

#path ⇒ `::String`

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

#port ⇒ `::Integer`

#request_method ⇒ `::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod`

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

#use_ssl ⇒ `::Boolean`

#validate_ssl ⇒ `::Boolean`