google_api_monitoring v0.12.0 GoogleApi.Monitoring.V3.Model.UptimeCheckConfig View Source

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

Attributes

  • contentMatchers (type: list(GoogleApi.Monitoring.V3.Model.ContentMatcher.t), default: nil) - The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.
  • 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 CheckConfig.
  • monitoredResource (type: GoogleApi.Monitoring.V3.Model.MonitoredResource.t, default: nil) - The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: 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 UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].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 to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all 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

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

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

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.