Class HttpCheck

Information involved in an HTTP/HTTPS Uptime check request.

Inheritance
object
HttpCheck
Implements
Inherited Members
Namespace: Google.Apis.Monitoring.v3.Data
Assembly: Google.Apis.Monitoring.v3.dll
Syntax
public class HttpCheck : IDirectResponseSchema

Properties

AcceptedResponseStatusCodes

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.

Declaration
[JsonProperty("acceptedResponseStatusCodes")]
public virtual IList<ResponseStatusCode> AcceptedResponseStatusCodes { get; set; }
Property Value
Type Description
IList<ResponseStatusCode>

AuthInfo

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

Declaration
[JsonProperty("authInfo")]
public virtual BasicAuthentication AuthInfo { get; set; }
Property Value
Type Description
BasicAuthentication

Body

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.

Declaration
[JsonProperty("body")]
public virtual string Body { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("contentType")]
public virtual string ContentType { get; set; }
Property Value
Type Description
string

CustomContentType

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.

Declaration
[JsonProperty("customContentType")]
public virtual string CustomContentType { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Headers

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.

Declaration
[JsonProperty("headers")]
public virtual IDictionary<string, string> Headers { get; set; }
Property Value
Type Description
IDictionary<string, string>

MaskHeaders

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

Declaration
[JsonProperty("maskHeaders")]
public virtual bool? MaskHeaders { get; set; }
Property Value
Type Description
bool?

Path

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.

Declaration
[JsonProperty("path")]
public virtual string Path { get; set; }
Property Value
Type Description
string

PingConfig

Contains information needed to add pings to an HTTP check.

Declaration
[JsonProperty("pingConfig")]
public virtual PingConfig PingConfig { get; set; }
Property Value
Type Description
PingConfig

Port

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.

Declaration
[JsonProperty("port")]
public virtual int? Port { get; set; }
Property Value
Type Description
int?

RequestMethod

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

Declaration
[JsonProperty("requestMethod")]
public virtual string RequestMethod { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("serviceAgentAuthentication")]
public virtual ServiceAgentAuthentication ServiceAgentAuthentication { get; set; }
Property Value
Type Description
ServiceAgentAuthentication

UseSsl

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

Declaration
[JsonProperty("useSsl")]
public virtual bool? UseSsl { get; set; }
Property Value
Type Description
bool?

ValidateSsl

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.

Declaration
[JsonProperty("validateSsl")]
public virtual bool? ValidateSsl { get; set; }
Property Value
Type Description
bool?

Implements