Class: Google::Apis::MonitoringV3::UptimeCheckConfig
- Inherits:
-
Object
- Object
- Google::Apis::MonitoringV3::UptimeCheckConfig
- 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
-
#content_matchers ⇒ Array<Google::Apis::MonitoringV3::ContentMatcher>
The expected content on the page the check is run against.
-
#display_name ⇒ String
A human-friendly name for the uptime check configuration.
-
#http_check ⇒ Google::Apis::MonitoringV3::HttpCheck
Information involved in an HTTP/HTTPS uptime check request.
-
#internal_checkers ⇒ Array<Google::Apis::MonitoringV3::InternalChecker>
The internal checkers that this check will egress from.
-
#monitored_resource ⇒ Google::Apis::MonitoringV3::MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes.
-
#name ⇒ String
A unique resource name for this UptimeCheckConfig.
-
#period ⇒ String
How often, in seconds, the uptime check is performed.
-
#resource_group ⇒ Google::Apis::MonitoringV3::ResourceGroup
The resource submessage for group checks.
-
#selected_regions ⇒ Array<String>
The list of regions from which the check will be run.
-
#tcp_check ⇒ Google::Apis::MonitoringV3::TcpCheck
Information required for a TCP uptime check request.
-
#timeout ⇒ String
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
Instance Method Summary collapse
-
#initialize(**args) ⇒ UptimeCheckConfig
constructor
A new instance of UptimeCheckConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ UptimeCheckConfig
Returns a new instance of UptimeCheckConfig
2869 2870 2871 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2869 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content_matchers ⇒ Array<Google::Apis::MonitoringV3::ContentMatcher>
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.
Corresponds to the JSON property contentMatchers
2791 2792 2793 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2791 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
2798 2799 2800 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2798 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
2803 2804 2805 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2803 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 CheckConfig.
Corresponds to the JSON property internalCheckers
2810 2811 2812 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2810 def internal_checkers @internal_checkers 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 "instance_id" and "
zone":
"type": "gce_instance",
"labels":
"instance_id": "12345678901234",
"zone": "us-central1-a" `
Corresponds to the JSON property
monitoredResource`
2826 2827 2828 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2826 def monitored_resource @monitored_resource end |
#name ⇒ String
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.
Corresponds to the JSON property name
2834 2835 2836 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2834 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
2841 2842 2843 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2841 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
2847 2848 2849 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2847 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 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.
Corresponds to the JSON property selectedRegions
2856 2857 2858 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2856 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
2861 2862 2863 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2861 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
2867 2868 2869 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2867 def timeout @timeout end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 |
# File 'generated/google/apis/monitoring_v3/classes.rb', line 2874 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) @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 |