Struct google_api_proto::google::monitoring::v3::uptime_check_config::HttpCheck

pub struct HttpCheck {

    pub request_method: i32,
    pub use_ssl: bool,
    pub path: String,
    pub port: i32,
    pub auth_info: Option<BasicAuthentication>,
    pub mask_headers: bool,
    pub headers: BTreeMap<String, String>,
    pub content_type: i32,
    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>,
}

Information involved in an HTTP/HTTPS Uptime check request.

Fields

request_method: i32

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: BTreeMap<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: i32

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 request_method(&self) -> RequestMethod

Returns the enum value of request_method, or the default if the field is set to an invalid enum value.

pub fn set_request_method(&mut self, value: RequestMethod)

Sets request_method to the provided enum value.

pub fn content_type(&self) -> ContentType

Returns the enum value of content_type, or the default if the field is set to an invalid enum value.

pub fn set_content_type(&mut self, value: ContentType)

Sets content_type to the provided enum value.

Trait Implementations

impl Clone for HttpCheck

fn clone(&self) -> HttpCheck

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for HttpCheck

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for HttpCheck

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HttpCheck