Class UptimeCheckConfig (2.21.0)

Version latest

• 2.21.0 (latest)
• 2.20.0
• 2.19.4
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.2
• 2.13.0
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.2
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.2
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.1.2
• 1.0.0
• 0.36.2
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0

UptimeCheckConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
name	str 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.
display_name	str 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.
monitored_resource	google.api.monitored_resource_pb2.MonitoredResource The `monitored resource
resource_group	google.cloud.monitoring_v3.types.UptimeCheckConfig.ResourceGroup The group resource associated with the configuration. This field is a member of oneof_ resource.
synthetic_monitor	google.cloud.monitoring_v3.types.SyntheticMonitorTarget Specifies a Synthetic Monitor to invoke. This field is a member of oneof_ resource.
http_check	google.cloud.monitoring_v3.types.UptimeCheckConfig.HttpCheck Contains information needed to make an HTTP or HTTPS check. This field is a member of oneof_ check_request_type.
tcp_check	google.cloud.monitoring_v3.types.UptimeCheckConfig.TcpCheck Contains information needed to make a TCP check. This field is a member of oneof_ check_request_type.
period	google.protobuf.duration_pb2.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.
timeout	google.protobuf.duration_pb2.Duration The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
content_matchers	MutableSequence[google.cloud.monitoring_v3.types.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.
checker_type	google.cloud.monitoring_v3.types.UptimeCheckConfig.CheckerType The type of checkers to use to execute the Uptime check.
selected_regions	MutableSequence[google.cloud.monitoring_v3.types.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.
is_internal	bool 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.
internal_checkers	MutableSequence[google.cloud.monitoring_v3.types.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.
user_labels	MutableMapping[str, str] 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.

Classes

CheckerType

CheckerType(value)

What kind of checkers are available to be used by the check.

Values: CHECKER_TYPE_UNSPECIFIED (0): The default checker type. Currently converted to STATIC_IP_CHECKERS on creation, the default conversion behavior may change in the future. STATIC_IP_CHECKERS (1): STATIC_IP_CHECKERS are used for uptime checks that perform egress across the public internet. STATIC_IP_CHECKERS use the static IP addresses returned by ListUptimeCheckIps. VPC_CHECKERS (3): VPC_CHECKERS are used for uptime checks that perform egress using Service Directory and private network access. When using VPC_CHECKERS, the monitored resource type must be servicedirectory_service.

ContentMatcher

ContentMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

HttpCheck

HttpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information involved in an HTTP/HTTPS Uptime check request.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PingConfig

PingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain.

ResourceGroup

ResourceGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.

TcpCheck

TcpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information required for a TCP Uptime check request.

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.