class Google::Apis::MonitoringV3::UptimeCheckConfig

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

Attributes

checker_type[RW]

The type of checkers to use to execute the Uptime check. Corresponds to the JSON property `checkerType` @return [String]

content_matchers[RW]

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. Corresponds to the JSON property `contentMatchers` @return [Array<Google::Apis::MonitoringV3::ContentMatcher>]

display_name[RW]

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. Corresponds to the JSON property `displayName` @return [String]

http_check[RW]

Information involved in an HTTP/HTTPS Uptime check request. Corresponds to the JSON property `httpCheck` @return [Google::Apis::MonitoringV3::HttpCheck]

internal_checkers[RW]

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. Corresponds to the JSON property `internalCheckers` @return [Array<Google::Apis::MonitoringV3::InternalChecker>]

is_internal[RW]

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. Corresponds to the JSON property `isInternal` @return [Boolean]

is_internal?[RW]

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. Corresponds to the JSON property `isInternal` @return [Boolean]

monitored_resource[RW]

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for “gce_instance” has labels “project_id”, “ instance_id” and “zone”: ` “type”: “gce_instance”, “labels”: ` “project_id”: “ my-project”, “instance_id”: “12345678901234”, “zone”: “us-central1-a” “ Corresponds to the JSON property `monitoredResource` @return [Google::Apis::MonitoringV3::MonitoredResource]

name[RW]

A unique resource name for this Uptime check configuration. The format is: projects//uptimeCheckConfigs/ [ 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. Corresponds to the JSON property `name` @return [String]

period[RW]

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. Corresponds to the JSON property `period` @return [String]

resource_group[RW]

The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. Corresponds to the JSON property `resourceGroup` @return [Google::Apis::MonitoringV3::ResourceGroup]

selected_regions[RW]

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. Corresponds to the JSON property `selectedRegions` @return [Array<String>]

tcp_check[RW]

Information required for a TCP Uptime check request. Corresponds to the JSON property `tcpCheck` @return [Google::Apis::MonitoringV3::TcpCheck]

timeout[RW]

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. Corresponds to the JSON property `timeout` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/monitoring_v3/classes.rb, line 4494
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/monitoring_v3/classes.rb, line 4499
def update!(**args)
  @checker_type = args[:checker_type] if args.key?(:checker_type)
  @content_matchers = args[:content_matchers] if args.key?(:content_matchers)
  @display_name = args[:display_name] if args.key?(:display_name)
  @http_check = args[:http_check] if args.key?(:http_check)
  @internal_checkers = args[:internal_checkers] if args.key?(:internal_checkers)
  @is_internal = args[:is_internal] if args.key?(:is_internal)
  @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource)
  @name = args[:name] if args.key?(:name)
  @period = args[:period] if args.key?(:period)
  @resource_group = args[:resource_group] if args.key?(:resource_group)
  @selected_regions = args[:selected_regions] if args.key?(:selected_regions)
  @tcp_check = args[:tcp_check] if args.key?(:tcp_check)
  @timeout = args[:timeout] if args.key?(:timeout)
end