Blame - docs/dyn/compute_alpha.regionHealthCheckServices.html - platform/external/python/google-api-python-client

blob: 8b42f532372e9116ab1d55abd82b4658d51d8aad [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
				75	<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionHealthCheckServices.html">regionHealthCheckServices</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	78	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	79	<p class="firstline">Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project.</p>
				80	<p class="toc_element">
				81	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				82	<p class="firstline">Retrieves the next page of results.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	87	<code><a href="#delete">delete(project, region, healthCheckService, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified regional HealthCheckService.</p>
				89	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#get">get(project, region, healthCheckService, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Returns the specified regional HealthCheckService resource.</p>
				92	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	93	<code><a href="#insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.</p>
				95	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Lists all the HealthCheckService resources that have been configured for the specified project in the given region.</p>
				98	<p class="toc_element">
				99	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				100	<p class="firstline">Retrieves the next page of results.</p>
				101	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	102	<code><a href="#patch">patch(project, region, healthCheckService, body=None, requestId=None, x__xgafv=None)</a></code></p>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	103	<p class="firstline">Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
				104	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	105	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	106	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				107	<h3>Method Details</h3>
				108	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	109	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	110	<pre>Retrieves the list of all HealthCheckService resources, regional and global, available to the specified project.
				111
				112	Args:
				113	project: string, Name of the project scoping this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	114	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	115	includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
				116	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	117	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	118	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
				119	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	120	x__xgafv: string, V1 error format.
				121	Allowed values
				122	1 - v1 error format
				123	2 - v2 error format
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	124
				125	Returns:
				126	An object of the form:
				127
				128	{ # Contains a list of HealthCheckServicesScopedList.
				129	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				130	"items": { # A list of HealthCheckServicesScopedList resources.
				131	"a_key": { # Name of the scope containing this set of HealthCheckServices.
				132	"resources": [ # A list of HealthCheckServices contained in this scope.
				133	{ # Represents a Health-Check as a Service resource.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	134	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				135	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				136	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	137	"healthChecks": [ # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	138	"A String",
				139	],
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	140	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	141	"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	142	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				143	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				144	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	145	"networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	146	"A String",
				147	],
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	148	"notificationEndpoints": [ # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	149	"A String",
				150	],
				151	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				152	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				153	"selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
				154	},
				155	],
				156	"warning": { # Informational warning which replaces the list of backend services when the list is empty.
				157	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	158	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	159	{
				160	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				161	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				162	},
				163	],
				164	"message": "A String", # [Output Only] A human-readable description of the warning code.
				165	},
				166	},
				167	},
				168	"kind": "compute#healthCheckServiceAggregatedList", # Type of resource.
				169	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				170	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				171	"unreachables": [ # [Output Only] Unreachable resources.
				172	"A String",
				173	],
				174	"warning": { # [Output Only] Informational warning message.
				175	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	176	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	177	{
				178	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				179	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				180	},
				181	],
				182	"message": "A String", # [Output Only] A human-readable description of the warning code.
				183	},
				184	}</pre>
				185	</div>
				186
				187	<div class="method">
				188	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				189	<pre>Retrieves the next page of results.
				190
				191	Args:
				192	previous_request: The request for the previous page. (required)
				193	previous_response: The response from the request for the previous page. (required)
				194
				195	Returns:
				196	A request object that you can call 'execute()' on to request the next
				197	page. Returns None if there are no more items in the collection.
				198	</pre>
				199	</div>
				200
				201	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	202	<code class="details" id="close">close()</code>
				203	<pre>Close httplib2 connections.</pre>
				204	</div>
				205
				206	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	207	<code class="details" id="delete">delete(project, region, healthCheckService, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	208	<pre>Deletes the specified regional HealthCheckService.
				209
				210	Args:
				211	project: string, Project ID for this request. (required)
				212	region: string, Name of the region scoping this request. (required)
				213	healthCheckService: string, Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	214	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				215	x__xgafv: string, V1 error format.
				216	Allowed values
				217	1 - v1 error format
				218	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	219
				220	Returns:
				221	An object of the form:
				222
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	223	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	224	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				225	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				226	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				227	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				228	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				229	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	230	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	231	"code": "A String", # [Output Only] The error type identifier for this error.
				232	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				233	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	234	},
				235	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	236	},
				237	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				238	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				239	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				240	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				241	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	242	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				243	"a_key": "", # Properties of the object. Contains field @type with type URL.
				244	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	245	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	246	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	247	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				248	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				249	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				250	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				251	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				252	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				253	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				254	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				255	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				256	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				257	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				258	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				259	{
				260	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	261	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	262	{
				263	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				264	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				265	},
				266	],
				267	"message": "A String", # [Output Only] A human-readable description of the warning code.
				268	},
				269	],
				270	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				271	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	272	</div>
				273
				274	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	275	<code class="details" id="get">get(project, region, healthCheckService, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	276	<pre>Returns the specified regional HealthCheckService resource.
				277
				278	Args:
				279	project: string, Project ID for this request. (required)
				280	region: string, Name of the region scoping this request. (required)
				281	healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	282	x__xgafv: string, V1 error format.
				283	Allowed values
				284	1 - v1 error format
				285	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	286
				287	Returns:
				288	An object of the form:
				289
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	290	{ # Represents a Health-Check as a Service resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	291	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				292	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				293	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	294	"healthChecks": [ # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	295	"A String",
				296	],
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	297	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	298	"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	299	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				300	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				301	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	302	"networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	303	"A String",
				304	],
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	305	"notificationEndpoints": [ # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	306	"A String",
				307	],
				308	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				309	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				310	"selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
				311	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	312	</div>
				313
				314	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	315	<code class="details" id="insert">insert(project, region, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	316	<pre>Creates a regional HealthCheckService resource in the specified project and region using the data included in the request.
				317
				318	Args:
				319	project: string, Project ID for this request. (required)
				320	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	321	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	322	The object takes the form of:
				323
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	324	{ # Represents a Health-Check as a Service resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	325	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				326	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				327	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	328	"healthChecks": [ # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	329	"A String",
				330	],
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	331	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	332	"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	333	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				334	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				335	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	336	"networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	337	"A String",
				338	],
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	339	"notificationEndpoints": [ # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	340	"A String",
				341	],
				342	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				343	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				344	"selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
				345	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	346
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	347	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				348	x__xgafv: string, V1 error format.
				349	Allowed values
				350	1 - v1 error format
				351	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	352
				353	Returns:
				354	An object of the form:
				355
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	356	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	357	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				358	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				359	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				360	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				361	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				362	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	363	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	364	"code": "A String", # [Output Only] The error type identifier for this error.
				365	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				366	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	367	},
				368	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	},
				370	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				371	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				372	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				373	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				374	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	375	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				376	"a_key": "", # Properties of the object. Contains field @type with type URL.
				377	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	379	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	380	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				381	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				382	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				383	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				384	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				385	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				386	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				387	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				388	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				389	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				390	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				391	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				392	{
				393	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	394	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	395	{
				396	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				397	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				398	},
				399	],
				400	"message": "A String", # [Output Only] A human-readable description of the warning code.
				401	},
				402	],
				403	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				404	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	405	</div>
				406
				407	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	408	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	409	<pre>Lists all the HealthCheckService resources that have been configured for the specified project in the given region.
				410
				411	Args:
				412	project: string, Project ID for this request. (required)
				413	region: string, Name of the region scoping this request. (required)
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	414	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner: ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	415	maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	416	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	417	pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	418	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	419	x__xgafv: string, V1 error format.
				420	Allowed values
				421	1 - v1 error format
				422	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	423
				424	Returns:
				425	An object of the form:
				426
				427	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	428	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				429	"items": [ # A list of HealthCheckService resources.
				430	{ # Represents a Health-Check as a Service resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	431	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				432	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				433	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	434	"healthChecks": [ # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	435	"A String",
				436	],
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	437	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	438	"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	439	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				440	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				441	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	442	"networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	443	"A String",
				444	],
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	445	"notificationEndpoints": [ # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	446	"A String",
				447	],
				448	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				449	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				450	"selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
				451	},
				452	],
				453	"kind": "compute#healthCheckServicesList", # [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices.
				454	"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
				455	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				456	"warning": { # [Output Only] Informational warning message.
				457	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	458	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	459	{
				460	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				461	"value": "A String", # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	462	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	463	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	464	"message": "A String", # [Output Only] A human-readable description of the warning code.
				465	},
				466	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	467	</div>
				468
				469	<div class="method">
				470	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				471	<pre>Retrieves the next page of results.
				472
				473	Args:
				474	previous_request: The request for the previous page. (required)
				475	previous_response: The response from the request for the previous page. (required)
				476
				477	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	478	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]	479	page. Returns None if there are no more items in the collection.
				480	</pre>
				481	</div>
				482
				483	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	484	<code class="details" id="patch">patch(project, region, healthCheckService, body=None, requestId=None, x__xgafv=None)</code>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	485	<pre>Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
				486
				487	Args:
				488	project: string, Project ID for this request. (required)
				489	region: string, Name of the region scoping this request. (required)
				490	healthCheckService: string, Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
				491	body: object, The request body.
				492	The object takes the form of:
				493
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	494	{ # Represents a Health-Check as a Service resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	495	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				496	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				497	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	498	"healthChecks": [ # A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NEGs.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	499	"A String",
				500	],
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	501	"healthStatusAggregationPolicy": "A String", # Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. .
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	502	"healthStatusAggregationStrategy": "A String", # This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. .
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	503	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				504	"kind": "compute#healthCheckService", # [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
				505	"name": "A String", # Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	506	"networkEndpointGroups": [ # A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	507	"A String",
				508	],
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	509	"notificationEndpoints": [ # A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	510	"A String",
				511	],
				512	"region": "A String", # [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				513	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				514	"selfLinkWithId": "A String", # [Output Only] Server-defined URL with id for the resource.
				515	}
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	516
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	517	requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
				518	x__xgafv: string, V1 error format.
				519	Allowed values
				520	1 - v1 error format
				521	2 - v2 error format
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	522
				523	Returns:
				524	An object of the form:
				525
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	526	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	527	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				528	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				529	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				530	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				531	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				532	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	533	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	534	"code": "A String", # [Output Only] The error type identifier for this error.
				535	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				536	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	537	},
				538	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	539	},
				540	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				541	"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
				542	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				543	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				544	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	8595441	2021-12-06 23:26:37 -0800	[diff] [blame^]	545	"metadata": { # [Output Only] Service-specific metadata attached to this operation.
				546	"a_key": "", # Properties of the object. Contains field @type with type URL.
				547	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	548	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	549	"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	550	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				551	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				552	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				553	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				554	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				555	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				556	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				557	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				558	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				559	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				560	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				561	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				562	{
				563	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	564	"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	565	{
				566	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				567	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				568	},
				569	],
				570	"message": "A String", # [Output Only] A human-readable description of the warning code.
				571	},
				572	],
				573	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				574	}</pre>
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	575	</div>
				576
				577	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	578	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	579	<pre>Returns permissions that a caller has on the specified resource.
				580
				581	Args:
				582	project: string, Project ID for this request. (required)
				583	region: string, The name of the region for this request. (required)
				584	resource: string, Name or id of the resource for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	585	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	586	The object takes the form of:
				587
				588	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	589	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				590	"A String",
				591	],
				592	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	593
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	594	x__xgafv: string, V1 error format.
				595	Allowed values
				596	1 - v1 error format
				597	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	598
				599	Returns:
				600	An object of the form:
				601
				602	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	603	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				604	"A String",
				605	],
				606	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	607	</div>
				608
				609	</body></html>