Method: Google::Cloud::Monitoring::V3::UptimeCheckConfig#name

Defined in:

proto_docs/google/monitoring/v3/uptime.rb

#name ⇒ ::String

Returns A unique resource name for this Uptime check configuration. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Returns:

• (::String) —

  A unique resource name for this Uptime check configuration. The format is:

   projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
  

  [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

  This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

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

class UptimeCheckConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The resource submessage for group checks. It can be used instead of a
  # monitored resource, when multiple resources are being monitored.
  # @!attribute [rw] group_id
  #   @return [::String]
  #     The group of resources being monitored. Should be only the `[GROUP_ID]`,
  #     and not the full-path
  #     `projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]`.
  # @!attribute [rw] resource_type
  #   @return [::Google::Cloud::Monitoring::V3::GroupResourceType]
  #     The resource type of the group members.
  class ResourceGroup
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information involved in an HTTP/HTTPS Uptime check request.
  # @!attribute [rw] request_method
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod]
  #     The HTTP request method to use for the check. If set to
  #     `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
  # @!attribute [rw] use_ssl
  #   @return [::Boolean]
  #     If `true`, use HTTPS instead of HTTP to run the check.
  # @!attribute [rw] path
  #   @return [::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.
  # @!attribute [rw] port
  #   @return [::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.
  # @!attribute [rw] auth_info
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication]
  #     The authentication information. Optional when creating an HTTP check;
  #     defaults to empty.
  # @!attribute [rw] mask_headers
  #   @return [::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 `******.`
  # @!attribute [rw] headers
  #   @return [::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.
  # @!attribute [rw] content_type
  #   @return [::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.
  # @!attribute [rw] validate_ssl
  #   @return [::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.
  # @!attribute [rw] body
  #   @return [::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: As with
  #     all `bytes` fields, JSON representations are base64 encoded. e.g.:
  #     "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is
  #     "Zm9vJTI1M0RiYXI=".
  class HttpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The authentication parameters to provide to the specified resource or
    # URL that requires a username and password. Currently, only
    # [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is
    # supported in Uptime checks.
    # @!attribute [rw] username
    #   @return [::String]
    #     The username to use when authenticating with the HTTP server.
    # @!attribute [rw] password
    #   @return [::String]
    #     The password to use when authenticating with the HTTP server.
    class BasicAuthentication
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class HeadersEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The HTTP request method options.
    module RequestMethod
      # No request method specified.
      METHOD_UNSPECIFIED = 0

      # GET request.
      GET = 1

      # POST request.
      POST = 2
    end

    # Header options corresponding to the content type of a HTTP request body.
    module ContentType
      # No content type specified.
      TYPE_UNSPECIFIED = 0

      # `body` is in URL-encoded form. Equivalent to setting the `Content-Type`
      # to `application/x-www-form-urlencoded` in the HTTP request.
      URL_ENCODED = 1
    end
  end

  # Information required for a TCP Uptime check request.
  # @!attribute [rw] port
  #   @return [::Integer]
  #     The TCP port on the server against which to run the check. Will be
  #     combined with host (specified within the `monitored_resource`) to
  #     construct the full URL. Required.
  class TcpCheck
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Optional. Used to perform content matching. This allows matching based on
  # substrings and regular expressions, together with their negations. Only the
  # first 4 MB of an HTTP or HTTPS check's response (and the first
  # 1 MB of a TCP check's response) are examined for purposes of content
  # matching.
  # @!attribute [rw] content
  #   @return [::String]
  #     String or regex content to match. Maximum 1024 bytes. An empty `content`
  #     string indicates no content matching is to be performed.
  # @!attribute [rw] matcher
  #   @return [::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher::ContentMatcherOption]
  #     The type of content matcher that will be applied to the server output,
  #     compared to the `content` string when the check is run.
  class ContentMatcher
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Options to perform content matching.
    module ContentMatcherOption
      # No content matcher type specified (maintained for backward
      # compatibility, but deprecated for future use).
      # Treated as `CONTAINS_STRING`.
      CONTENT_MATCHER_OPTION_UNSPECIFIED = 0

      # Selects substring matching. The match succeeds if the output contains
      # the `content` string.  This is the default value for checks without
      # a `matcher` option, or where the value of `matcher` is
      # `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
      CONTAINS_STRING = 1

      # Selects negation of substring matching. The match succeeds if the
      # output does _NOT_ contain the `content` string.
      NOT_CONTAINS_STRING = 2

      # Selects regular-expression matching. The match succeeds of the output
      # matches the regular expression specified in the `content` string.
      # Regex matching is only supported for HTTP/HTTPS checks.
      MATCHES_REGEX = 3

      # Selects negation of regular-expression matching. The match succeeds if
      # the output does _NOT_ match the regular expression specified in the
      # `content` string. Regex matching is only supported for HTTP/HTTPS
      # checks.
      NOT_MATCHES_REGEX = 4
    end
  end
end