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
#auth_info
def auth_info() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication
- (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty.
#auth_info=
def auth_info=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication
- value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty.
- (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::BasicAuthentication) — The authentication information. Optional when creating an HTTP check; defaults to empty.
#body
def body() -> ::String
-
(::String) — The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with allbytes
fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
#body=
def body=(value) -> ::String
-
value (::String) — The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with allbytes
fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
-
(::String) — The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with allbytes
fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
#content_type
def content_type() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType
-
(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType) —
The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headers
field and thecontent_type
field. - Request method is
GET
andcontent_type
is notTYPE_UNSPECIFIED
- Request method is
POST
andcontent_type
isTYPE_UNSPECIFIED
. - Request method is
POST
and a "Content-Type" header is provided viaheaders
field. Thecontent_type
field should be used instead.
- Content type is specified in both the
#content_type=
def content_type=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType
-
value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType) —
The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headers
field and thecontent_type
field. - Request method is
GET
andcontent_type
is notTYPE_UNSPECIFIED
- Request method is
POST
andcontent_type
isTYPE_UNSPECIFIED
. - Request method is
POST
and a "Content-Type" header is provided viaheaders
field. Thecontent_type
field should be used instead.
- Content type is specified in both the
-
(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::ContentType) —
The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headers
field and thecontent_type
field. - Request method is
GET
andcontent_type
is notTYPE_UNSPECIFIED
- Request method is
POST
andcontent_type
isTYPE_UNSPECIFIED
. - Request method is
POST
and a "Content-Type" header is provided viaheaders
field. Thecontent_type
field should be used instead.
- Content type is specified in both the
#headers
def headers() -> ::Google::Protobuf::Map{::String => ::String}
- (::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}
- 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.
- (::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
-
(::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 totrue
then the headers will be obscured with******.
#mask_headers=
def mask_headers=(value) -> ::Boolean
-
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 totrue
then the headers will be obscured with******.
-
(::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 totrue
then the headers will be obscured with******.
#path
def path() -> ::String
-
(::String) — Optional (defaults to "/"). The path to the page against which to run
the check. Will be combined with the
host
(specified within themonitored_resource
) andport
to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
#path=
def path=(value) -> ::String
-
value (::String) — Optional (defaults to "/"). The path to the page against which to run
the check. Will be combined with the
host
(specified within themonitored_resource
) andport
to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
-
(::String) — Optional (defaults to "/"). The path to the page against which to run
the check. Will be combined with the
host
(specified within themonitored_resource
) andport
to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
#port
def port() -> ::Integer
-
(::Integer) — Optional (defaults to 80 when
use_ssl
isfalse
, and 443 whenuse_ssl
istrue
). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within themonitored_resource
) andpath
to construct the full URL.
#port=
def port=(value) -> ::Integer
-
value (::Integer) — Optional (defaults to 80 when
use_ssl
isfalse
, and 443 whenuse_ssl
istrue
). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within themonitored_resource
) andpath
to construct the full URL.
-
(::Integer) — Optional (defaults to 80 when
use_ssl
isfalse
, and 443 whenuse_ssl
istrue
). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within themonitored_resource
) andpath
to construct the full URL.
#request_method
def request_method() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod
-
(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
.
#request_method=
def request_method=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod
-
value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
.
-
(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck::RequestMethod) — The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
.
#use_ssl
def use_ssl() -> ::Boolean
-
(::Boolean) — If
true
, use HTTPS instead of HTTP to run the check.
#use_ssl=
def use_ssl=(value) -> ::Boolean
-
value (::Boolean) — If
true
, use HTTPS instead of HTTP to run the check.
-
(::Boolean) — If
true
, use HTTPS instead of HTTP to run the check.
#validate_ssl
def validate_ssl() -> ::Boolean
-
(::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 touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
#validate_ssl=
def validate_ssl=(value) -> ::Boolean
-
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 touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
-
(::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 touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.