Class: Google::Apis::MonitoringV3::UptimeCheckConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UptimeCheckConfig

Returns a new instance of UptimeCheckConfig.



4254
4255
4256
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4254

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#checker_type ⇒ String

The type of checkers to use to execute the Uptime check. Corresponds to the JSON property checkerType

Returns:

  • (String) 


4159
4160
4161
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4159

def checker_type
  @checker_type
end

#content_matchers ⇒ Array<Google::Apis::MonitoringV3::ContentMatcher>

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

Returns:



4168
4169
4170
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4168

def content_matchers
  @content_matchers
end

#display_name ⇒ String

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. Corresponds to the JSON property displayName

Returns:

  • (String) 


4175
4176
4177
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4175

def display_name
  @display_name
end

#http_check ⇒ Google::Apis::MonitoringV3::HttpCheck

Information involved in an HTTP/HTTPS Uptime check request. Corresponds to the JSON property httpCheck

Returns:



4180
4181
4182
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4180

def http_check
  @http_check
end

#internal_checkers ⇒ Array<Google::Apis::MonitoringV3::InternalChecker>

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

Returns:



4187
4188
4189
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4187

def internal_checkers
  @internal_checkers
end

#is_internal ⇒ Boolean Also known as: is_internal?

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

Returns:

  • (Boolean) 


4195
4196
4197
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4195

def is_internal
  @is_internal
end

#monitored_resource ⇒ Google::Apis::MonitoringV3::MonitoredResource

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 propertymonitoredResource`

Returns:



4210
4211
4212
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4210

def monitored_resource
  @monitored_resource
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


4220
4221
4222
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4220

def name
  @name
end

#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. Corresponds to the JSON property period

Returns:

  • (String) 


4227
4228
4229
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4227

def period
  @period
end

#resource_group ⇒ Google::Apis::MonitoringV3::ResourceGroup

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

Returns:



4233
4234
4235
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4233

def resource_group
  @resource_group
end

#selected_regions ⇒ Array<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. Corresponds to the JSON property selectedRegions

Returns:

  • (Array<String>) 


4241
4242
4243
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4241

def selected_regions
  @selected_regions
end

#tcp_check ⇒ Google::Apis::MonitoringV3::TcpCheck

Information required for a TCP Uptime check request. Corresponds to the JSON property tcpCheck

Returns:



4246
4247
4248
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4246

def tcp_check
  @tcp_check
end

#timeout ⇒ String

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

Returns:

  • (String) 


4252
4253
4254
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4252

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 4259

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