Google Cloud Monitoring v3 API - Class UptimeCheckConfig (3.4.0) 

public sealed class UptimeCheckConfig : IMessage<UptimeCheckConfig>, IEquatable<UptimeCheckConfig>, IDeepCloneable<UptimeCheckConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Monitoring v3 API class UptimeCheckConfig.

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

Inheritance

object > UptimeCheckConfig

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

UptimeCheckConfig()

public UptimeCheckConfig()

UptimeCheckConfig(UptimeCheckConfig)

public UptimeCheckConfig(UptimeCheckConfig other)
Parameter
NameDescription
otherUptimeCheckConfig

Properties

CheckerType

public UptimeCheckConfig.Types.CheckerType CheckerType { get; set; }

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

Property Value
TypeDescription
UptimeCheckConfigTypesCheckerType

CheckRequestTypeCase

public UptimeCheckConfig.CheckRequestTypeOneofCase CheckRequestTypeCase { get; }
Property Value
TypeDescription
UptimeCheckConfigCheckRequestTypeOneofCase

ContentMatchers

public RepeatedField<UptimeCheckConfig.Types.ContentMatcher> ContentMatchers { get; }

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.

Property Value
TypeDescription
RepeatedFieldUptimeCheckConfigTypesContentMatcher

DisplayName

public string DisplayName { get; set; }

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.

Property Value
TypeDescription
string

HttpCheck

public UptimeCheckConfig.Types.HttpCheck HttpCheck { get; set; }

Contains information needed to make an HTTP or HTTPS check.

Property Value
TypeDescription
UptimeCheckConfigTypesHttpCheck

InternalCheckers

[Obsolete]
public RepeatedField<InternalChecker> InternalCheckers { get; }

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.

Property Value
TypeDescription
RepeatedFieldInternalChecker

IsInternal

[Obsolete]
public bool IsInternal { get; set; }

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.

Property Value
TypeDescription
bool

MonitoredResource

public MonitoredResource MonitoredResource { get; set; }

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

Property Value
TypeDescription
MonitoredResource

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
string

Period

public Duration Period { get; set; }

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.

Property Value
TypeDescription
Duration

ResourceCase

public UptimeCheckConfig.ResourceOneofCase ResourceCase { get; }
Property Value
TypeDescription
UptimeCheckConfigResourceOneofCase

ResourceGroup

public UptimeCheckConfig.Types.ResourceGroup ResourceGroup { get; set; }

The group resource associated with the configuration.

Property Value
TypeDescription
UptimeCheckConfigTypesResourceGroup

ResourceName

public IResourceName ResourceName { get; set; }

IResourceName-typed view over the Name resource name property.

Property Value
TypeDescription
IResourceName

SelectedRegions

public RepeatedField<UptimeCheckRegion> SelectedRegions { get; }

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.

Property Value
TypeDescription
RepeatedFieldUptimeCheckRegion

TcpCheck

public UptimeCheckConfig.Types.TcpCheck TcpCheck { get; set; }

Contains information needed to make a TCP check.

Property Value
TypeDescription
UptimeCheckConfigTypesTcpCheck

Timeout

public Duration Timeout { get; set; }

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

Property Value
TypeDescription
Duration

UptimeCheckConfigName

public UptimeCheckConfigName UptimeCheckConfigName { get; set; }

UptimeCheckConfigName-typed view over the Name resource name property.

Property Value
TypeDescription
UptimeCheckConfigName

UserLabels

public MapField<string, string> UserLabels { get; }

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.

Property Value
TypeDescription
MapFieldstringstring