Copyright 2020 Google LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Code generated by protoc-gen-go. DO NOT EDIT. versions: protoc-gen-go v1.25.0 protoc v3.13.0 source: google/monitoring/v3/uptime.proto
The supported resource types that can be used as values of `group_resource.resource_type`. `INSTANCE` includes `gce_instance` and `aws_ec2_instance` resource types. The resource types `gae_app` and `uptime_url` are not valid here because group checks on App Engine modules and URLs are not allowed.
An internal checker should never be in the unspecified state.
The checker is being created, provisioned, and configured. A checker in this state can be returned by `ListInternalCheckers` or `GetInternalChecker`, as well as by examining the [long running Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations) that created it.
The checker is running and available for use. A checker in this state can be returned by `ListInternalCheckers` or `GetInternalChecker` as well as by examining the [long running Operation](https://cloud.google.com/apis/design/design_patterns#long_running_operations) that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state.
Header options corresponding to the Content-Type of the body in HTTP requests. Note that a `Content-Type` header cannot be present in the `headers` field if this field is specified.
No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as `CONTAINS_STRING`.
Selects substring matching. The match succeeds if the output contains the `content` string. This is the default value for checks without a `matcher` option, or where the value of `matcher` is `CONTENT_MATCHER_OPTION_UNSPECIFIED`.
Selects negation of substring matching. The match succeeds if the output does _NOT_ contain the `content` string.
Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the `content` string.
Selects negation of regular-expression matching. The match succeeds if the output does _NOT_ match the regular expression specified in the `content` string.
A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] `[PROJECT_ID_OR_NUMBER]` is the Stackdriver Workspace project for the Uptime check config associated with the internal checker.
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.
The [GCP VPC network](https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
The current operational state of the internal checker.
A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/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.
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.
The resource the check is checking. Required. Types that are assignable to Resource: *UptimeCheckConfig_MonitoredResource *UptimeCheckConfig_ResourceGroup_
The type of Uptime check request. Types that are assignable to CheckRequestType: *UptimeCheckConfig_HttpCheck_ *UptimeCheckConfig_TcpCheck_
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`.
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
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.
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.
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`. Deprecated: Do not use.
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`. Deprecated: Do not use.
The [monitored resource](https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for Uptime checks: `uptime_url`, `gce_instance`, `gae_app`, `aws_ec2_instance`, `aws_elb_load_balancer`
A broad region category in which the IP address is located.
A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.
The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.
If `true`, use HTTPS instead of HTTP to run the check.
Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the `host` (specified within the `monitored_resource`) and `port` to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
Optional (defaults to 80 when `use_ssl` is `false`, and 443 when `use_ssl` is `true`). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the `monitored_resource`) and `path` to construct the full URL.
The authentication information. Optional when creating an HTTP check; defaults to empty.
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 `******.`
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.
The content type to use for the check.
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where `monitored_resource` is set to `uptime_url`. If `use_ssl` is `false`, setting `validate_ssl` to `true` has no effect.
The request body associated with the HTTP request. If `content_type` is `URL_ENCODED`, the body passed in must be URL-encoded. Users can provide a `Content-Length` header via the `headers` field or the API will do so. The maximum byte size is 1 megabyte. Note: As with all `bytes` fields JSON representations are base64 encoded.
The TCP port on the server against which to run the check. Will be combined with host (specified within the `monitored_resource`) to construct the full URL. Required.
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.
The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only [Basic HTTP authentication](https://tools.ietf.org/html/rfc7617) is supported in Uptime checks.
The pages are generated with Goldsv0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.