parent STRING Required

The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]

pageToken STRING

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call

pageSize INTEGER

The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned

uptimeCheckConfigs[] OBJECT

This message configures which resources and services to monitor for availability

uptimeCheckConfigs[].resourceGroup OBJECT

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

uptimeCheckConfigs[].resourceGroup.resourceType ENUMERATION

The resource type of the group members

uptimeCheckConfigs[].resourceGroup.groupId STRING

The group of resources being monitored. Should be only the group_id, not projects/<project_id>/groups/<group_id>

uptimeCheckConfigs[].tcpCheck OBJECT

Information required for a TCP uptime check request

uptimeCheckConfigs[].tcpCheck.port INTEGER

The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required

uptimeCheckConfigs[].internalCheckers[] OBJECT

An internal checker allows uptime checks to run on private/internal GCP resources

uptimeCheckConfigs[].internalCheckers[].peerProjectId STRING

The GCP project_id where the internal checker lives. Not necessary the same as the workspace project

uptimeCheckConfigs[].internalCheckers[].state ENUMERATION

The current operational state of the internal checker

uptimeCheckConfigs[].internalCheckers[].name STRING

A unique resource name for this InternalChecker. The format is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].PROJECT_ID is the stackdriver workspace project for the uptime check config associated with the internal checker

uptimeCheckConfigs[].internalCheckers[].gcpZone STRING

The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified

uptimeCheckConfigs[].internalCheckers[].network STRING

The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default")

uptimeCheckConfigs[].internalCheckers[].displayName STRING

The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced

uptimeCheckConfigs[].selectedRegions[] ENUMERATION

uptimeCheckConfigs[].displayName 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

uptimeCheckConfigs[].contentMatchers[] OBJECT

Used to perform string matching. It allows substring and regular expressions, together with their negations

uptimeCheckConfigs[].contentMatchers[].content STRING

String or regex content to match (max 1024 bytes)

uptimeCheckConfigs[].monitoredResource OBJECT

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" }}

uptimeCheckConfigs[].monitoredResource.type STRING

Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types

uptimeCheckConfigs[].monitoredResource.labels OBJECT

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone"

uptimeCheckConfigs[].monitoredResource.labels.customKey.value STRING

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone"

uptimeCheckConfigs[].timeout ANY

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

uptimeCheckConfigs[].period ANY

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

uptimeCheckConfigs[].httpCheck OBJECT

Information involved in an HTTP/HTTPS uptime check request

uptimeCheckConfigs[].httpCheck.useSsl BOOLEAN

If true, use HTTPS instead of HTTP to run the check

uptimeCheckConfigs[].httpCheck.maskHeaders BOOLEAN

Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******

uptimeCheckConfigs[].httpCheck.authInfo OBJECT

A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring

uptimeCheckConfigs[].httpCheck.authInfo.password STRING

The password to authenticate

uptimeCheckConfigs[].httpCheck.authInfo.username STRING

The username to authenticate

uptimeCheckConfigs[].httpCheck.headers OBJECT

The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100

uptimeCheckConfigs[].httpCheck.headers.customKey.value STRING

The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100

uptimeCheckConfigs[].httpCheck.path STRING

The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/"). If the provided path does not begin with "/", it will be prepended automatically

uptimeCheckConfigs[].httpCheck.port INTEGER

The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL)

uptimeCheckConfigs[].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

nextPageToken STRING

This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field)

totalSize INTEGER

The total number of uptime check configurations for the project, irrespective of any pagination