UptimeCheckConfigHttpCheckArgs

data class UptimeCheckConfigHttpCheckArgs(val acceptedResponseStatusCodes: Output<List<UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs>>? = null, val authInfo: Output<UptimeCheckConfigHttpCheckAuthInfoArgs>? = null, val body: Output<String>? = null, val contentType: Output<String>? = null, val headers: Output<Map<String, String>>? = null, val maskHeaders: Output<Boolean>? = null, val path: Output<String>? = null, val port: Output<Int>? = null, val requestMethod: Output<String>? = null, val useSsl: Output<Boolean>? = null, val validateSsl: Output<Boolean>? = null) : ConvertibleToJava<UptimeCheckConfigHttpCheckArgs>

Constructors

Link copied to clipboard
constructor(acceptedResponseStatusCodes: Output<List<UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs>>? = null, authInfo: Output<UptimeCheckConfigHttpCheckAuthInfoArgs>? = null, body: Output<String>? = null, contentType: Output<String>? = null, headers: Output<Map<String, String>>? = null, maskHeaders: Output<Boolean>? = null, path: Output<String>? = null, port: Output<Int>? = null, requestMethod: Output<String>? = null, useSsl: Output<Boolean>? = null, validateSsl: Output<Boolean>? = null)

Properties

Link copied to clipboard

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. Structure is documented below.

Link copied to clipboard

The authentication information. Optional when creating an HTTP check; defaults to empty. Structure is documented below.

Link copied to clipboard
val body: Output<String>? = null

The request body associated with the HTTP POST request. If contentType 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 requestMethod 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=".

Link copied to clipboard
val contentType: Output<String>? = null

The content type to use for the check. Possible values are: TYPE_UNSPECIFIED, URL_ENCODED.

Link copied to clipboard
val headers: Output<Map<String, String>>? = null

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.

Link copied to clipboard
val maskHeaders: Output<Boolean>? = null

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

Link copied to clipboard
val path: Output<String>? = null

The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically. Optional (defaults to "/").

Link copied to clipboard
val port: Output<Int>? = null

The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).

Link copied to clipboard
val requestMethod: Output<String>? = null

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then requestMethod defaults to GET. Default value is GET. Possible values are: METHOD_UNSPECIFIED, GET, POST.

Link copied to clipboard
val useSsl: Output<Boolean>? = null

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

Link copied to clipboard
val validateSsl: Output<Boolean>? = null

Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

Functions

Link copied to clipboard
open override fun toJava(): UptimeCheckConfigHttpCheckArgs