Google Cloud Monitoring v3 API - Class UptimeCheckConfig.Types.HttpCheck (3.11.0)

Version latest

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0

public sealed class UptimeCheckConfig.Types.HttpCheck : IMessage<UptimeCheckConfig.Types.HttpCheck>, IEquatable<UptimeCheckConfig.Types.HttpCheck>, IDeepCloneable<UptimeCheckConfig.Types.HttpCheck>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Monitoring v3 API class UptimeCheckConfig.Types.HttpCheck.

Information involved in an HTTP/HTTPS Uptime check request.

Inheritance

object > UptimeCheckConfig.Types.HttpCheck

Implements

IMessageUptimeCheckConfigTypesHttpCheck, IEquatableUptimeCheckConfigTypesHttpCheck, IDeepCloneableUptimeCheckConfigTypesHttpCheck, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

HttpCheck()

public HttpCheck()

HttpCheck(HttpCheck)

public HttpCheck(UptimeCheckConfig.Types.HttpCheck other)

Parameter
Name	Description
other	UptimeCheckConfigTypesHttpCheck

Properties

AcceptedResponseStatusCodes

public RepeatedField<UptimeCheckConfig.Types.HttpCheck.Types.ResponseStatusCode> AcceptedResponseStatusCodes { get; }

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.

Property Value
Type	Description
RepeatedFieldUptimeCheckConfigTypesHttpCheckTypesResponseStatusCode

AuthInfo

public UptimeCheckConfig.Types.HttpCheck.Types.BasicAuthentication AuthInfo { get; set; }

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

Property Value
Type	Description
UptimeCheckConfigTypesHttpCheckTypesBasicAuthentication

AuthMethodCase

public UptimeCheckConfig.Types.HttpCheck.AuthMethodOneofCase AuthMethodCase { get; }

Property Value
Type	Description
UptimeCheckConfigTypesHttpCheckAuthMethodOneofCase

Body

public ByteString Body { get; set; }

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.

Property Value
Type	Description
ByteString

ContentType

public UptimeCheckConfig.Types.HttpCheck.Types.ContentType ContentType { get; set; }

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.

Property Value
Type	Description
UptimeCheckConfigTypesHttpCheckTypesContentType

CustomContentType

public string CustomContentType { get; set; }

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.

Property Value
Type	Description
string

Headers

public MapField<string, string> Headers { get; }

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.

Property Value
Type	Description
MapFieldstringstring

MaskHeaders

public bool MaskHeaders { get; set; }

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

Property Value
Type	Description
bool

Path

public string Path { get; set; }

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.

Property Value
Type	Description
string

PingConfig

public UptimeCheckConfig.Types.PingConfig PingConfig { get; set; }

Contains information needed to add pings to an HTTP check.

Property Value
Type	Description
UptimeCheckConfigTypesPingConfig

Port

public int Port { get; set; }

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.

Property Value
Type	Description
int

RequestMethod

public UptimeCheckConfig.Types.HttpCheck.Types.RequestMethod RequestMethod { get; set; }

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

Property Value
Type	Description
UptimeCheckConfigTypesHttpCheckTypesRequestMethod

ServiceAgentAuthentication

public UptimeCheckConfig.Types.HttpCheck.Types.ServiceAgentAuthentication ServiceAgentAuthentication { get; set; }

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.

Property Value
Type	Description
UptimeCheckConfigTypesHttpCheckTypesServiceAgentAuthentication

UseSsl

public bool UseSsl { get; set; }

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

Property Value
Type	Description
bool

ValidateSsl

public bool ValidateSsl { get; set; }

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.

Property Value
Type	Description
bool