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
#content_matchers
def content_matchers() -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ContentMatcher>
-
(::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>
-
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.
-
(::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
- (::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.
#display_name=
def display_name=(value) -> ::String
- value (::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.
- (::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.
#http_check
def http_check() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck
- (::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
- value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::HttpCheck) — Contains information needed to make an HTTP or HTTPS check.
- (::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>
-
(::Array<::Google::Cloud::Monitoring::V3::InternalChecker>) — The internal checkers that this check will egress from. If
is_internal
istrue
and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns thisUptimeCheckConfig
.
#internal_checkers=
def internal_checkers=(value) -> ::Array<::Google::Cloud::Monitoring::V3::InternalChecker>
-
value (::Array<::Google::Cloud::Monitoring::V3::InternalChecker>) — The internal checkers that this check will egress from. If
is_internal
istrue
and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns thisUptimeCheckConfig
.
-
(::Array<::Google::Cloud::Monitoring::V3::InternalChecker>) — The internal checkers that this check will egress from. If
is_internal
istrue
and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns thisUptimeCheckConfig
.
#is_internal
def is_internal() -> ::Boolean
-
(::Boolean) — If this is
true
, then checks are made only from the 'internal_checkers'. If it isfalse
, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal istrue
, or to provide 'internal_checkers' when is_internal isfalse
.
#is_internal=
def is_internal=(value) -> ::Boolean
-
value (::Boolean) — If this is
true
, then checks are made only from the 'internal_checkers'. If it isfalse
, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal istrue
, or to provide 'internal_checkers' when is_internal isfalse
.
-
(::Boolean) — If this is
true
, then checks are made only from the 'internal_checkers'. If it isfalse
, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal istrue
, or to provide 'internal_checkers' when is_internal isfalse
.
#monitored_resource
def monitored_resource() -> ::Google::Api::MonitoredResource
-
(::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
#monitored_resource=
def monitored_resource=(value) -> ::Google::Api::MonitoredResource
-
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
-
(::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
#name
def name() -> ::String
-
(::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.
#name=
def name=(value) -> ::String
-
value (::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.
-
(::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.
#period
def period() -> ::Google::Protobuf::Duration
-
(::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), and900s
(15 minutes). Optional, defaults to60s
.
#period=
def period=(value) -> ::Google::Protobuf::Duration
-
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), and900s
(15 minutes). Optional, defaults to60s
.
-
(::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), and900s
(15 minutes). Optional, defaults to60s
.
#resource_group
def resource_group() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup
- (::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
- value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup) — The group resource associated with the configuration.
- (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::ResourceGroup) — The group resource associated with the configuration.
#selected_regions
def selected_regions() -> ::Array<::Google::Cloud::Monitoring::V3::UptimeCheckRegion>
- (::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>
- 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.
- (::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.
#tcp_check
def tcp_check() -> ::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck
- (::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
- value (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck) — Contains information needed to make a TCP check.
- (::Google::Cloud::Monitoring::V3::UptimeCheckConfig::TcpCheck) — Contains information needed to make a TCP check.
#timeout
def timeout() -> ::Google::Protobuf::Duration
- (::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
- value (::Google::Protobuf::Duration) — The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
- (::Google::Protobuf::Duration) — The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.