Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck.

Information involved in an HTTP/HTTPS Uptime check request.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#accepted_response_status_codes

def accepted_response_status_codes() -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode>

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

#accepted_response_status_codes=

def accepted_response_status_codes=(value) -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ResponseStatusCode>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

#auth_info

def auth_info() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.

#auth_info=

def auth_info=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.

#body

def body() -> ::String

Returns

(::String) — 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.

#body=

def body=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#content_type

def content_type() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

#content_type=

def content_type=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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

def custom_content_type() -> ::String

Returns

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

#custom_content_type=

def custom_content_type=(value) -> ::String

Parameter

value (::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.

Returns

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

#headers

def headers() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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.

#headers=

def headers=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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.

Returns

(::Google::Protobuf::Map{::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.

#mask_headers

def mask_headers() -> ::Boolean

Returns

(::Boolean) — 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 ******.

#mask_headers=

def mask_headers=(value) -> ::Boolean

Parameter

value (::Boolean) — 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 ******.

Returns

(::Boolean) — 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 ******.

#path

def path() -> ::String

Returns

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

#path=

def path=(value) -> ::String

Parameter

value (::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.

Returns

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

#ping_config

def ping_config() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig) — Contains information needed to add pings to an HTTP check.

#ping_config=

def ping_config=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig) — Contains information needed to add pings to an HTTP check.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::PingConfig) — Contains information needed to add pings to an HTTP check.

#port

def port() -> ::Integer

Returns

(::Integer) — 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.

#port=

def port=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.

#request_method

def request_method() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

#request_method=

def request_method=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

#service_agent_authentication

def service_agent_authentication() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

#service_agent_authentication=

def service_agent_authentication=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ServiceAgentAuthentication

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::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.

#use_ssl

def use_ssl() -> ::Boolean

Returns

(::Boolean) — If true, use HTTPS instead of HTTP to run the check.

#use_ssl=

def use_ssl=(value) -> ::Boolean

Parameter

value (::Boolean) — If true, use HTTPS instead of HTTP to run the check.

Returns

(::Boolean) — If true, use HTTPS instead of HTTP to run the check.

#validate_ssl

def validate_ssl() -> ::Boolean

Returns

(::Boolean) — 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.

#validate_ssl=

def validate_ssl=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.