Blame - docs/dyn/monitoring_v3.projects.uptimeCheckConfigs.html - platform/external/python/google-api-python-client

blob: 737907eee72f0c492f0980524c58299dad900a2d [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	75	<h1><a href="monitoring_v3.html">Cloud Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.uptimeCheckConfigs.html">uptimeCheckConfigs</a></h1>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a new Uptime check configuration.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	83	<p class="toc_element">
				84	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	85	<p class="firstline">Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	88	<p class="firstline">Gets a single Uptime check configuration.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	90	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	91	<p class="firstline">Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98	<h3>Method Details</h3>
				99	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	<code class="details" id="close">close()</code>
				101	<pre>Close httplib2 connections.</pre>
				102	</div>
				103
				104	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				106	<pre>Creates a new Uptime check configuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	107
				108	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	parent: string, Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	110	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	The object takes the form of:
				112
				113	{ # This message configures which resources and services to monitor for availability.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	114	"contentMatchers": [ # 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.
				115	{ # 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.
				116	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				117	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	118	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	119	],
				120	"displayName": "A 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.
				121	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				122	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				123	"password": "A String", # The password to use when authenticating with the HTTP server.
				124	"username": "A String", # The username to use when authenticating with the HTTP server.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	125	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	126	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				127	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				128	"headers": { # 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.
				129	"a_key": "A String",
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	130	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	131	"maskHeaders": True or False, # Boolean specifying 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 ******.
				132	"path": "A String", # 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.
				133	"port": 42, # 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.
				134	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				135	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				136	"validateSsl": True or False, # 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.
				137	},
				138	"internalCheckers": [ # 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.
				139	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				140	"displayName": "A 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.
				141	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				142	"name": "A 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.
				143	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				144	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				145	"state": "A String", # The current operational state of the internal checker.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	146	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	147	],
				148	"isInternal": True or False, # 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.
				149	"monitoredResource": { # 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" }} # 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
				150	"labels": { # 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".
				151	"a_key": "A String",
				152	},
				153	"type": "A 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.
				154	},
				155	"name": "A 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.
				156	"period": "A String", # 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.
				157	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				158	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				159	"resourceType": "A String", # The resource type of the group members.
				160	},
				161	"selectedRegions": [ # 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.
				162	"A String",
				163	],
				164	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				165	"port": 42, # 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.
				166	},
				167	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				168	}
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	169
				170	x__xgafv: string, V1 error format.
				171	Allowed values
				172	1 - v1 error format
				173	2 - v2 error format
				174
				175	Returns:
				176	An object of the form:
				177
				178	{ # This message configures which resources and services to monitor for availability.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	179	"contentMatchers": [ # 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.
				180	{ # 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.
				181	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				182	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
				183	},
				184	],
				185	"displayName": "A 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.
				186	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				187	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				188	"password": "A String", # The password to use when authenticating with the HTTP server.
				189	"username": "A String", # The username to use when authenticating with the HTTP server.
				190	},
				191	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				192	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				193	"headers": { # 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.
				194	"a_key": "A String",
				195	},
				196	"maskHeaders": True or False, # Boolean specifying 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 ******.
				197	"path": "A String", # 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.
				198	"port": 42, # 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.
				199	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				200	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				201	"validateSsl": True or False, # 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.
				202	},
				203	"internalCheckers": [ # 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.
				204	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				205	"displayName": "A 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.
				206	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				207	"name": "A 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.
				208	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				209	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				210	"state": "A String", # The current operational state of the internal checker.
				211	},
				212	],
				213	"isInternal": True or False, # 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.
				214	"monitoredResource": { # 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" }} # 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
				215	"labels": { # 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".
				216	"a_key": "A String",
				217	},
				218	"type": "A 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.
				219	},
				220	"name": "A 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.
				221	"period": "A String", # 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.
				222	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				223	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				224	"resourceType": "A String", # The resource type of the group members.
				225	},
				226	"selectedRegions": [ # 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.
				227	"A String",
				228	],
				229	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				230	"port": 42, # 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.
				231	},
				232	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				233	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	234	</div>
				235
				236	<div class="method">
				237	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	238	<pre>Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	239
				240	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	241	name: string, Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	242	x__xgafv: string, V1 error format.
				243	Allowed values
				244	1 - v1 error format
				245	2 - v2 error format
				246
				247	Returns:
				248	An object of the form:
				249
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	250	{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	251	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	252	</div>
				253
				254	<div class="method">
				255	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	256	<pre>Gets a single Uptime check configuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	257
				258	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	259	name: string, Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	260	x__xgafv: string, V1 error format.
				261	Allowed values
				262	1 - v1 error format
				263	2 - v2 error format
				264
				265	Returns:
				266	An object of the form:
				267
				268	{ # This message configures which resources and services to monitor for availability.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	269	"contentMatchers": [ # 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.
				270	{ # 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.
				271	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				272	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
				273	},
				274	],
				275	"displayName": "A 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.
				276	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				277	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				278	"password": "A String", # The password to use when authenticating with the HTTP server.
				279	"username": "A String", # The username to use when authenticating with the HTTP server.
				280	},
				281	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				282	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				283	"headers": { # 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.
				284	"a_key": "A String",
				285	},
				286	"maskHeaders": True or False, # Boolean specifying 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 ******.
				287	"path": "A String", # 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.
				288	"port": 42, # 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.
				289	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				290	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				291	"validateSsl": True or False, # 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.
				292	},
				293	"internalCheckers": [ # 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.
				294	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				295	"displayName": "A 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.
				296	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				297	"name": "A 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.
				298	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				299	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				300	"state": "A String", # The current operational state of the internal checker.
				301	},
				302	],
				303	"isInternal": True or False, # 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.
				304	"monitoredResource": { # 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" }} # 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
				305	"labels": { # 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".
				306	"a_key": "A String",
				307	},
				308	"type": "A 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.
				309	},
				310	"name": "A 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.
				311	"period": "A String", # 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.
				312	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				313	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				314	"resourceType": "A String", # The resource type of the group members.
				315	},
				316	"selectedRegions": [ # 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.
				317	"A String",
				318	],
				319	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				320	"port": 42, # 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.
				321	},
				322	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				323	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	324	</div>
				325
				326	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	327	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	328	<pre>Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	329
				330	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	331	parent: string, Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] (required)
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	332	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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	333	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	334	x__xgafv: string, V1 error format.
				335	Allowed values
				336	1 - v1 error format
				337	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	338
				339	Returns:
				340	An object of the form:
				341
				342	{ # The protocol for the ListUptimeCheckConfigs response.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	343	"nextPageToken": "A 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).
				344	"totalSize": 42, # The total number of Uptime check configurations for the project, irrespective of any pagination.
				345	"uptimeCheckConfigs": [ # The returned Uptime check configurations.
				346	{ # This message configures which resources and services to monitor for availability.
				347	"contentMatchers": [ # 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.
				348	{ # 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.
				349	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				350	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	351	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	352	],
				353	"displayName": "A 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.
				354	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				355	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				356	"password": "A String", # The password to use when authenticating with the HTTP server.
				357	"username": "A String", # The username to use when authenticating with the HTTP server.
				358	},
				359	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				360	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				361	"headers": { # 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.
				362	"a_key": "A String",
				363	},
				364	"maskHeaders": True or False, # Boolean specifying 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 ******.
				365	"path": "A String", # 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.
				366	"port": 42, # 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.
				367	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				368	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				369	"validateSsl": True or False, # 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.
				370	},
				371	"internalCheckers": [ # 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.
				372	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				373	"displayName": "A 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.
				374	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				375	"name": "A 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.
				376	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				377	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				378	"state": "A String", # The current operational state of the internal checker.
				379	},
				380	],
				381	"isInternal": True or False, # 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.
				382	"monitoredResource": { # 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" }} # 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
				383	"labels": { # 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".
				384	"a_key": "A String",
				385	},
				386	"type": "A 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.
				387	},
				388	"name": "A 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.
				389	"period": "A String", # 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.
				390	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				391	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				392	"resourceType": "A String", # The resource type of the group members.
				393	},
				394	"selectedRegions": [ # 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.
				395	"A String",
				396	],
				397	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				398	"port": 42, # 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.
				399	},
				400	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				401	},
				402	],
				403	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	404	</div>
				405
				406	<div class="method">
				407	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				408	<pre>Retrieves the next page of results.
				409
				410	Args:
				411	previous_request: The request for the previous page. (required)
				412	previous_response: The response from the request for the previous page. (required)
				413
				414	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	415	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	416	page. Returns None if there are no more items in the collection.
				417	</pre>
				418	</div>
				419
				420	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	421	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
				422	<pre>Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423
				424	Args:
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	425	name: 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. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	426	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	427	The object takes the form of:
				428
				429	{ # This message configures which resources and services to monitor for availability.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	430	"contentMatchers": [ # 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.
				431	{ # 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.
				432	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				433	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	434	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	435	],
				436	"displayName": "A 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.
				437	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				438	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				439	"password": "A String", # The password to use when authenticating with the HTTP server.
				440	"username": "A String", # The username to use when authenticating with the HTTP server.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	441	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	442	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				443	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				444	"headers": { # 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.
				445	"a_key": "A String",
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	446	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	447	"maskHeaders": True or False, # Boolean specifying 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 ******.
				448	"path": "A String", # 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.
				449	"port": 42, # 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.
				450	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				451	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				452	"validateSsl": True or False, # 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.
				453	},
				454	"internalCheckers": [ # 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.
				455	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				456	"displayName": "A 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.
				457	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				458	"name": "A 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.
				459	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				460	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				461	"state": "A String", # The current operational state of the internal checker.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	462	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	463	],
				464	"isInternal": True or False, # 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.
				465	"monitoredResource": { # 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" }} # 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
				466	"labels": { # 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".
				467	"a_key": "A String",
				468	},
				469	"type": "A 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.
				470	},
				471	"name": "A 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.
				472	"period": "A String", # 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.
				473	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				474	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				475	"resourceType": "A String", # The resource type of the group members.
				476	},
				477	"selectedRegions": [ # 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.
				478	"A String",
				479	],
				480	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				481	"port": 42, # 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.
				482	},
				483	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				484	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	485
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	486	updateMask: string, Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	487	x__xgafv: string, V1 error format.
				488	Allowed values
				489	1 - v1 error format
				490	2 - v2 error format
				491
				492	Returns:
				493	An object of the form:
				494
				495	{ # This message configures which resources and services to monitor for availability.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	496	"contentMatchers": [ # 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.
				497	{ # 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.
				498	"content": "A String", # String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
				499	"matcher": "A String", # The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
				500	},
				501	],
				502	"displayName": "A 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.
				503	"httpCheck": { # Information involved in an HTTP/HTTPS Uptime check request. # Contains information needed to make an HTTP or HTTPS check.
				504	"authInfo": { # 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 authentication information. Optional when creating an HTTP check; defaults to empty.
				505	"password": "A String", # The password to use when authenticating with the HTTP server.
				506	"username": "A String", # The username to use when authenticating with the HTTP server.
				507	},
				508	"body": "A String", # The request body associated with the HTTP POST 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. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".
				509	"contentType": "A String", # The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
				510	"headers": { # 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.
				511	"a_key": "A String",
				512	},
				513	"maskHeaders": True or False, # Boolean specifying 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 ******.
				514	"path": "A String", # 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.
				515	"port": 42, # 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.
				516	"requestMethod": "A String", # The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
				517	"useSsl": True or False, # If true, use HTTPS instead of HTTP to run the check.
				518	"validateSsl": True or False, # 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.
				519	},
				520	"internalCheckers": [ # 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.
				521	{ # An internal checker allows Uptime checks to run on private/internal GCP resources.
				522	"displayName": "A 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.
				523	"gcpZone": "A String", # The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
				524	"name": "A 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.
				525	"network": "A String", # The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default").
				526	"peerProjectId": "A String", # The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
				527	"state": "A String", # The current operational state of the internal checker.
				528	},
				529	],
				530	"isInternal": True or False, # 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.
				531	"monitoredResource": { # 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" }} # 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
				532	"labels": { # 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".
				533	"a_key": "A String",
				534	},
				535	"type": "A 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.
				536	},
				537	"name": "A 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.
				538	"period": "A String", # 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.
				539	"resourceGroup": { # The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. # The group resource associated with the configuration.
				540	"groupId": "A String", # The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID].
				541	"resourceType": "A String", # The resource type of the group members.
				542	},
				543	"selectedRegions": [ # 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.
				544	"A String",
				545	],
				546	"tcpCheck": { # Information required for a TCP Uptime check request. # Contains information needed to make a TCP check.
				547	"port": 42, # 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.
				548	},
				549	"timeout": "A String", # The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
				550	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	551	</div>
				552
				553	</body></html>