Stackdriver Monitoring V3 Client - Class HttpCheck (1.2.2)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class HttpCheck.

Information involved in an HTTP/HTTPS Uptime check request.

Generated from protobuf message google.monitoring.v3.UptimeCheckConfig.HttpCheck

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ request_method`	`int` 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`	`int` 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`	`Google\Cloud\Monitoring\V3\UptimeCheckConfig\HttpCheck\BasicAuthentication` The authentication information. Optional when creating an HTTP check; defaults to empty.
`↳ 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`	`array\|Google\Protobuf\Internal\MapField` 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`	`int` 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.
`↳ 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`	`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: 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=".

getRequestMethod

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;

Returns
Type	Description
`int`

setRequestMethod

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getUseSsl

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

Generated from protobuf field bool use_ssl = 1;

Returns
Type	Description
`bool`

setUseSsl

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

Generated from protobuf field bool use_ssl = 1;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPath

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.

Generated from protobuf field string path = 2;

Returns
Type	Description
`string`

setPath

Generated from protobuf field string path = 2;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPort

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.

Generated from protobuf field int32 port = 3;

Returns
Type	Description
`int`

setPort

Generated from protobuf field int32 port = 3;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getAuthInfo

The authentication information. Optional when creating an HTTP check; defaults to empty.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Returns
Type	Description
`Google\Cloud\Monitoring\V3\UptimeCheckConfig\HttpCheck\BasicAuthentication\|null`

hasAuthInfo

clearAuthInfo

setAuthInfo

The authentication information. Optional when creating an HTTP check; defaults to empty.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\UptimeCheckConfig\HttpCheck\BasicAuthentication`

Returns
Type	Description
`$this`

getMaskHeaders

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

Generated from protobuf field bool mask_headers = 5;

Returns
Type	Description
`bool`

setMaskHeaders

Boolean specifying whether to encrypt the header information.

Generated from protobuf field bool mask_headers = 5;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getHeaders

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.

Generated from protobuf field map<string, string> headers = 6;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setHeaders

The list of headers to send as part of the Uptime check request.

Generated from protobuf field map<string, string> headers = 6;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getContentType

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 the content_type field.
Request method is GET and content_type is not TYPE_UNSPECIFIED
Request method is POST and content_type is TYPE_UNSPECIFIED.
Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;

Returns
Type	Description
`int`

setContentType

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 the content_type field.
Request method is GET and content_type is not TYPE_UNSPECIFIED
Request method is POST and content_type is TYPE_UNSPECIFIED.
Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.

Generated from protobuf field .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getValidateSsl

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.

Generated from protobuf field bool validate_ssl = 7;

Returns
Type	Description
`bool`

setValidateSsl

Generated from protobuf field bool validate_ssl = 7;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getBody

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: 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=".

Generated from protobuf field bytes body = 10;

Returns
Type	Description
`string`

setBody

Generated from protobuf field bytes body = 10;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`