Class UptimeCheckConfig

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

Inheritance
object
UptimeCheckConfig
Implements
Inherited Members
Namespace: Google.Apis.Monitoring.v3.Data
Assembly: Google.Apis.Monitoring.v3.dll
Syntax
public class UptimeCheckConfig : IDirectResponseSchema

Properties

CheckerType

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

Declaration
[JsonProperty("checkerType")]
public virtual string CheckerType { get; set; }
Property Value
Type Description
string

ContentMatchers

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.

Declaration
[JsonProperty("contentMatchers")]
public virtual IList<ContentMatcher> ContentMatchers { get; set; }
Property Value
Type Description
IList<ContentMatcher>

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

HttpCheck

Contains information needed to make an HTTP or HTTPS check.

Declaration
[JsonProperty("httpCheck")]
public virtual HttpCheck HttpCheck { get; set; }
Property Value
Type Description
HttpCheck

InternalCheckers

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.

Declaration
[JsonProperty("internalCheckers")]
public virtual IList<InternalChecker> InternalCheckers { get; set; }
Property Value
Type Description
IList<InternalChecker>

IsInternal

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.

Declaration
[JsonProperty("isInternal")]
public virtual bool? IsInternal { get; set; }
Property Value
Type Description
bool?

MonitoredResource

The monitored resource (https://cloud.google.com/monitoring/api/resources) 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

Declaration
[JsonProperty("monitoredResource")]
public virtual MonitoredResource MonitoredResource { get; set; }
Property Value
Type Description
MonitoredResource

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Period

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.

Declaration
[JsonProperty("period")]
public virtual object Period { get; set; }
Property Value
Type Description
object

ResourceGroup

The group resource associated with the configuration.

Declaration
[JsonProperty("resourceGroup")]
public virtual ResourceGroup ResourceGroup { get; set; }
Property Value
Type Description
ResourceGroup

SelectedRegions

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.

Declaration
[JsonProperty("selectedRegions")]
public virtual IList<string> SelectedRegions { get; set; }
Property Value
Type Description
IList<string>

SyntheticMonitor

Specifies a Synthetic Monitor to invoke.

Declaration
[JsonProperty("syntheticMonitor")]
public virtual SyntheticMonitorTarget SyntheticMonitor { get; set; }
Property Value
Type Description
SyntheticMonitorTarget

TcpCheck

Contains information needed to make a TCP check.

Declaration
[JsonProperty("tcpCheck")]
public virtual TcpCheck TcpCheck { get; set; }
Property Value
Type Description
TcpCheck

Timeout

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

Declaration
[JsonProperty("timeout")]
public virtual object Timeout { get; set; }
Property Value
Type Description
object

UserLabels

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.

Declaration
[JsonProperty("userLabels")]
public virtual IDictionary<string, string> UserLabels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements