Struct HttpCheck 

#[non_exhaustive]
pub struct HttpCheck {

    pub request_method: RequestMethod,
    pub use_ssl: bool,
    pub path: String,
    pub port: i32,
    pub auth_info: Option<BasicAuthentication>,
    pub mask_headers: bool,
    pub headers: HashMap<String, String>,
    pub content_type: ContentType,
    pub custom_content_type: String,
    pub validate_ssl: bool,
    pub body: Bytes,
    pub accepted_response_status_codes: Vec<ResponseStatusCode>,
    pub ping_config: Option<PingConfig>,
    pub auth_method: Option<AuthMethod>,
    /* private fields */
}

Information involved in an HTTP/HTTPS Uptime check request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

request_method: 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: 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.

port: i32

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: Option<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: HashMap<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.

content_type: 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: String

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: Vec<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: Option<PingConfig>

Contains information needed to add pings to an HTTP check.

auth_method: Option<AuthMethod>

This field is optional and should be set only by users interested in an authenticated uptime check. Do not set both auth_method and auth_info.

Implementations

impl HttpCheck

pub fn new() -> Self

pub fn set_request_method<T: Into<RequestMethod>>(self, v: T) -> Self

Sets the value of request_method.

pub fn set_use_ssl<T: Into<bool>>(self, v: T) -> Self

Sets the value of use_ssl.

pub fn set_path<T: Into<String>>(self, v: T) -> Self

Sets the value of path.

pub fn set_port<T: Into<i32>>(self, v: T) -> Self

Sets the value of port.

pub fn set_auth_info<T>(self, v: T) -> Self

where T: Into<BasicAuthentication>,

Sets the value of auth_info.

pub fn set_or_clear_auth_info<T>(self, v: Option<T>) -> Self

where T: Into<BasicAuthentication>,

Sets or clears the value of auth_info.

pub fn set_mask_headers<T: Into<bool>>(self, v: T) -> Self

Sets the value of mask_headers.

pub fn set_headers<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of headers.

pub fn set_content_type<T: Into<ContentType>>(self, v: T) -> Self

Sets the value of content_type.

pub fn set_custom_content_type<T: Into<String>>(self, v: T) -> Self

Sets the value of custom_content_type.

pub fn set_validate_ssl<T: Into<bool>>(self, v: T) -> Self

Sets the value of validate_ssl.

pub fn set_body<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of body.

pub fn set_accepted_response_status_codes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<ResponseStatusCode>,

Sets the value of accepted_response_status_codes.

pub fn set_ping_config<T>(self, v: T) -> Self

where T: Into<PingConfig>,

Sets the value of ping_config.

pub fn set_or_clear_ping_config<T>(self, v: Option<T>) -> Self

where T: Into<PingConfig>,

Sets or clears the value of ping_config.

pub fn set_auth_method<T: Into<Option<AuthMethod>>>(self, v: T) -> Self

Sets the value of auth_method.

Note that all the setters affecting auth_method are mutually exclusive.

pub fn service_agent_authentication( &self, ) -> Option<&Box<ServiceAgentAuthentication>>

The value of auth_method if it holds a ServiceAgentAuthentication, None if the field is not set or holds a different branch.

pub fn set_service_agent_authentication<T: Into<Box<ServiceAgentAuthentication>>>( self, v: T, ) -> Self

Sets the value of auth_method to hold a ServiceAgentAuthentication.

Note that all the setters affecting auth_method are mutually exclusive.

Trait Implementations

impl Clone for HttpCheck

fn clone(&self) -> HttpCheck

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpCheck

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpCheck

fn default() -> HttpCheck

Returns the “default value” for a type.

impl Message for HttpCheck

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HttpCheck

fn eq(&self, other: &HttpCheck) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpCheck