Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::UptimeCheckConfig (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::UptimeCheckConfig.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#checker_type

def checker_type() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::CheckerType

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::CheckerType) — The type of checkers to use to execute the Uptime check.

#checker_type=

def checker_type=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::CheckerType

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::CheckerType) — The type of checkers to use to execute the Uptime check.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::CheckerType) — The type of checkers to use to execute the Uptime check.

#content_matchers

def content_matchers() -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher>

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::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.

#content_matchers=

def content_matchers=(value) -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::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.

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::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.

#display_name

def display_name() -> ::String

Returns

(::String) — 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.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — 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.

Returns

(::String) — 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.

#http_check

def http_check() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck) — Contains information needed to make an HTTP or HTTPS check.

#http_check=

def http_check=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck) — Contains information needed to make an HTTP or HTTPS check.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck) — Contains information needed to make an HTTP or HTTPS check.

#internal_checkers

def internal_checkers() -> ::Array<::Google::Cloud::Monitoring::V3::InternalChecker>

Returns

(::Array<::Google::Cloud::Monitoring::V3::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.

#internal_checkers=

def internal_checkers=(value) -> ::Array<::Google::Cloud::Monitoring::V3::InternalChecker>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::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.

Returns

(::Array<::Google::Cloud::Monitoring::V3::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.

#is_internal

def is_internal() -> ::Boolean

Returns

(::Boolean) — 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.

#is_internal=

def is_internal=(value) -> ::Boolean

Parameter

value (::Boolean) — 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.

Returns

(::Boolean) — 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.

#monitored_resource

def monitored_resource() -> ::Google::Api::MonitoredResource

Returns

(::Google::Api::MonitoredResource) — The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

#monitored_resource=

def monitored_resource=(value) -> ::Google::Api::MonitoredResource

Parameter

value (::Google::Api::MonitoredResource) — The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

Returns

(::Google::Api::MonitoredResource) — The monitored resource associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

#name

def name() -> ::String

Returns

(::String) — Identifier. 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.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. 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.

Returns

(::String) — Identifier. 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.

#period

def period() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — 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.

#period=

def period=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — 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.

Returns

(::Google::Protobuf::Duration) — 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.

#resource_group

def resource_group() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup) — The group resource associated with the configuration.

#resource_group=

def resource_group=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup) — The group resource associated with the configuration.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup) — The group resource associated with the configuration.

#selected_regions

def selected_regions() -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>) — 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.

#selected_regions=

def selected_regions=(value) -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>

Parameter

value (::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>) — 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.

Returns

(::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>) — 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.

#synthetic_monitor

def synthetic_monitor() -> ::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget

Returns

(::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget) — Specifies a Synthetic Monitor to invoke.

#synthetic_monitor=

def synthetic_monitor=(value) -> ::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget

Parameter

value (::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget) — Specifies a Synthetic Monitor to invoke.

Returns

(::Google::Cloud::Monitoring::V3::SyntheticMonitorTarget) — Specifies a Synthetic Monitor to invoke.

#tcp_check

def tcp_check() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck) — Contains information needed to make a TCP check.

#tcp_check=

def tcp_check=(value) -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck

Parameter

value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck) — Contains information needed to make a TCP check.

Returns

(::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck) — Contains information needed to make a TCP check.

#timeout

def timeout() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Returns

(::Google::Protobuf::Duration) — The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns

(::Google::Protobuf::Map{::String => ::String}) — User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.