Stackdriver Monitoring V3 Client - Class UptimeCheckConfig (1.6.0)

Version 1.6.0

• 1.11.1 (latest)
• 1.11.0
• 1.10.3
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.1
• 1.4.0
• 1.3.2
• 1.2.2

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

This message configures which resources and services to monitor for availability.

Generated from protobuf message google.monitoring.v3.UptimeCheckConfig

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check. This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.
↳ display_name	string A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.
↳ monitored_resource	Google\Api\MonitoredResource The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision
↳ resource_group	Google\Cloud\Monitoring\V3\UptimeCheckConfig\ResourceGroup The group resource associated with the configuration.
↳ http_check	Google\Cloud\Monitoring\V3\UptimeCheckConfig\HttpCheck Contains information needed to make an HTTP or HTTPS check.
↳ tcp_check	Google\Cloud\Monitoring\V3\UptimeCheckConfig\TcpCheck Contains information needed to make a TCP check.
↳ period	Google\Protobuf\Duration How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.
↳ timeout	Google\Protobuf\Duration The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
↳ content_matchers	array<Google\Cloud\Monitoring\V3\UptimeCheckConfig\ContentMatcher> The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
↳ checker_type	int The type of checkers to use to execute the Uptime check.
↳ selected_regions	array The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.
↳ is_internal	bool If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
↳ internal_checkers	array<Google\Cloud\Monitoring\V3\InternalChecker> The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
↳ user_labels	array|Google\Protobuf\Internal\MapField User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

getName

A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Returns
Type	Description
string

setName

A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

Returns
Type	Description
string

setDisplayName

A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMonitoredResource

The monitored resource associated with the configuration.

The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

Returns
Type	Description
Google\Api\MonitoredResource|null

hasMonitoredResource

setMonitoredResource

The monitored resource associated with the configuration.

The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

Parameter
Name	Description
var	Google\Api\MonitoredResource

Returns
Type	Description
$this

getResourceGroup

The group resource associated with the configuration.

Returns
Type	Description
Google\Cloud\Monitoring\V3\UptimeCheckConfig\ResourceGroup|null

hasResourceGroup

setResourceGroup

The group resource associated with the configuration.

Parameter
Name	Description
var	Google\Cloud\Monitoring\V3\UptimeCheckConfig\ResourceGroup

Returns
Type	Description
$this

getHttpCheck

Contains information needed to make an HTTP or HTTPS check.

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

hasHttpCheck

setHttpCheck

Contains information needed to make an HTTP or HTTPS check.

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

Returns
Type	Description
$this

getTcpCheck

Contains information needed to make a TCP check.

Returns
Type	Description
Google\Cloud\Monitoring\V3\UptimeCheckConfig\TcpCheck|null

hasTcpCheck

setTcpCheck

Contains information needed to make a TCP check.

Parameter
Name	Description
var	Google\Cloud\Monitoring\V3\UptimeCheckConfig\TcpCheck

Returns
Type	Description
$this

getPeriod

How often, in seconds, the Uptime check is performed.

Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

Returns
Type	Description
Google\Protobuf\Duration|null

hasPeriod

clearPeriod

setPeriod

How often, in seconds, the Uptime check is performed.

Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getTimeout

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Returns
Type	Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Parameter
Name	Description
var	Google\Protobuf\Duration

Returns
Type	Description
$this

getContentMatchers

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setContentMatchers

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

Parameter
Name	Description
var	array<Google\Cloud\Monitoring\V3\UptimeCheckConfig\ContentMatcher>

Returns
Type	Description
$this

getCheckerType

The type of checkers to use to execute the Uptime check.

Returns
Type	Description
int

setCheckerType

The type of checkers to use to execute the Uptime check.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getSelectedRegions

The list of regions from which the check will be run.

Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setSelectedRegions

The list of regions from which the check will be run.

Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getIsInternal

If this is true, then checks are made only from the 'internal_checkers'.

If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

Returns
Type	Description
bool

setIsInternal

If this is true, then checks are made only from the 'internal_checkers'.

If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInternalCheckers

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setInternalCheckers

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Parameter
Name	Description
var	array<Google\Cloud\Monitoring\V3\InternalChecker>

Returns
Type	Description
$this

getUserLabels

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setUserLabels

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

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

Returns
Type	Description
$this

getResource

Returns
Type	Description
string

getCheckRequestType

Returns
Type	Description
string