Class HttpCheck (2.22.1)

HttpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information involved in an HTTP/HTTPS Uptime check request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`request_method`	`google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck.RequestMethod` The HTTP request method to use for the check. If set to `METHOD_UNSPECIFIED` then `request_method` defaults to `GET`.
`use_ssl`	`bool` If `true`, use HTTPS instead of HTTP to run the check.
`path`	`str` 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.
`port`	`int` 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.
`auth_info`	`google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck.BasicAuthentication` The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both `auth_method` and `auth_info`.
`mask_headers`	`bool` 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 `******.`
`headers`	`MutableMapping[str, str]` 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.
`content_type`	`google.cloud.monitoring_v3.types.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.
`custom_content_type`	`str` 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.
`validate_ssl`	`bool` 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.
`body`	`bytes` 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.
`accepted_response_status_codes`	`MutableSequence[google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck.ResponseStatusCode]` 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.
`ping_config`	`google.cloud.monitoring_v3.types.UptimeCheckConfig.PingConfig` Contains information needed to add pings to an HTTP check.
`service_agent_authentication`	`google.cloud.monitoring_v3.types.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. This field is a member of `oneof`_ `auth_method`.

Classes

BasicAuthentication

BasicAuthentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

ContentType

ContentType(value)

Header options corresponding to the content type of a HTTP request body.

HeadersEntry

HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

RequestMethod

RequestMethod(value)

The HTTP request method options.

ResponseStatusCode

ResponseStatusCode(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A status to accept. Either a status code class like "2xx", or an integer status code like "200".

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.