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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v3/classes.rb,
generated/google/apis/monitoring_v3/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UptimeCheckConfig

Returns a new instance of UptimeCheckConfig.


3709
3710
3711
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3709

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

Instance Attribute Details

#content_matchersArray<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


3622
3623
3624
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3622

def content_matchers
  @content_matchers
end

#display_nameString

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)

3629
3630
3631
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3629

def display_name
  @display_name
end

#http_checkGoogle::Apis::MonitoringV3::HttpCheck

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


3634
3635
3636
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3634

def http_check
  @http_check
end

#internal_checkersArray<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


3641
3642
3643
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3641

def internal_checkers
  @internal_checkers
end

#is_internalBoolean 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)

3649
3650
3651
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3649

def is_internal
  @is_internal
end

#monitored_resourceGoogle::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 "instance_id" and " zone": "type": "gce_instance", "labels": "instance_id": "12345678901234", "zone": "us-central1-a" ` Corresponds to the JSON propertymonitoredResource`


3666
3667
3668
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3666

def monitored_resource
  @monitored_resource
end

#nameString

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

Returns:

  • (String)

3675
3676
3677
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3675

def name
  @name
end

#periodString

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)

3682
3683
3684
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3682

def period
  @period
end

#resource_groupGoogle::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


3688
3689
3690
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3688

def resource_group
  @resource_group
end

#selected_regionsArray<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>)

3696
3697
3698
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3696

def selected_regions
  @selected_regions
end

#tcp_checkGoogle::Apis::MonitoringV3::TcpCheck

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


3701
3702
3703
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3701

def tcp_check
  @tcp_check
end

#timeoutString

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)

3707
3708
3709
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3707

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
# File 'generated/google/apis/monitoring_v3/classes.rb', line 3714

def update!(**args)
  @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