GoogleApi.Monitoring.V3.Model.UptimeCheckConfig (google_api_monitoring v0.46.3) View Source

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


  • contentMatchers (type: list(GoogleApi.Monitoring.V3.Model.ContentMatcher.t), default: nil) - 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 (type: String.t, default: nil) - A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.
  • httpCheck (type: GoogleApi.Monitoring.V3.Model.HttpCheck.t, default: nil) - Contains information needed to make an HTTP or HTTPS check.
  • internalCheckers (type: list(GoogleApi.Monitoring.V3.Model.InternalChecker.t), default: nil) - 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 (type: boolean(), default: nil) - 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 (type: GoogleApi.Monitoring.V3.Model.MonitoredResource.t, default: nil) - 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
  • name (type: String.t, default: nil) - 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 (type: String.t, default: nil) - 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 (type: GoogleApi.Monitoring.V3.Model.ResourceGroup.t, default: nil) - The group resource associated with the configuration.
  • selectedRegions (type: list(String.t), default: nil) - 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.
  • tcpCheck (type: GoogleApi.Monitoring.V3.Model.TcpCheck.t, default: nil) - Contains information needed to make a TCP check.
  • timeout (type: String.t, default: nil) - The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Monitoring.V3.Model.UptimeCheckConfig{
  contentMatchers: [GoogleApi.Monitoring.V3.Model.ContentMatcher.t()] | nil,
  displayName: String.t() | nil,
  httpCheck: GoogleApi.Monitoring.V3.Model.HttpCheck.t() | nil,
  internalCheckers: [GoogleApi.Monitoring.V3.Model.InternalChecker.t()] | nil,
  isInternal: boolean() | nil,
  monitoredResource: GoogleApi.Monitoring.V3.Model.MonitoredResource.t() | nil,
  name: String.t() | nil,
  period: String.t() | nil,
  resourceGroup: GoogleApi.Monitoring.V3.Model.ResourceGroup.t() | nil,
  selectedRegions: [String.t()] | nil,
  tcpCheck: GoogleApi.Monitoring.V3.Model.TcpCheck.t() | nil,
  timeout: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.