GetUptimeCheckConfigResult class

Result data returned by getUptimeCheckConfig.

Constructors

GetUptimeCheckConfigResult({required String checkerType, required List<ContentMatcherResponse> contentMatchers, required String displayName, required HttpCheckResponse httpCheck, required List<InternalCheckerResponse> internalCheckers, required bool isInternal, required MonitoredResourceResponseMonitoringV3 monitoredResource, required String name, required String period, required ResourceGroupResponse resourceGroup, required List<String> selectedRegions, required SyntheticMonitorTargetResponse syntheticMonitor, required TcpCheckResponse tcpCheck, required String timeout, required Map<String, String> userLabels})
Creates a new GetUptimeCheckConfigResult. checkerType The type of checkers to use to execute the Uptime check. 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. 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. httpCheck Contains information needed to make an HTTP or HTTPS check. 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. 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. 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 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. 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. resourceGroup The group resource associated with the configuration. 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. syntheticMonitor Specifies a Synthetic Monitor to invoke. tcpCheck Contains information needed to make a TCP check. timeout The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. 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.
const
GetUptimeCheckConfigResult.fromMap(Map<String, dynamic> map)
factory

Properties

checkerType → String
The type of checkers to use to execute the Uptime check.
final
contentMatchers → List<ContentMatcherResponse>
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.
final
displayName → 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.
final
hashCode → int
The hash code for this object.
no setterinherited
httpCheck → HttpCheckResponse
Contains information needed to make an HTTP or HTTPS check.
final
internalCheckers → List<InternalCheckerResponse>
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.
final
isInternal → 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.
final
monitoredResource → MonitoredResourceResponseMonitoringV3
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
final
name → String
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.
final
period → String
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.
final
resourceGroup → ResourceGroupResponse
The group resource associated with the configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selectedRegions → List<String>
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.
final
syntheticMonitor → SyntheticMonitorTargetResponse
Specifies a Synthetic Monitor to invoke.
final
tcpCheck → TcpCheckResponse
Contains information needed to make a TCP check.
final
timeout → String
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
final
userLabels → Map<String, String>
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited