Blame - docs/dyn/compute_beta.httpHealthChecks.html - platform/external/python/google-api-python-client

blob: fd206b74148ad9b501addc6f0294716ab8a30281 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -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_beta.html">Compute Engine API</a> . <a href="compute_beta.httpHealthChecks.html">httpHealthChecks</a></h1>
				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">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, httpHealthCheck, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	82	<p class="firstline">Deletes the specified HttpHealthCheck resource.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(project, httpHealthCheck)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
				89	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	91	<p class="firstline">Retrieves the list of HttpHealthCheck resources available to the specified project.</p>
				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(project, httpHealthCheck, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	100	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#update">update(project, httpHealthCheck, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	103	<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	<code class="details" id="delete">delete(project, httpHealthCheck, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<pre>Deletes the specified HttpHealthCheck resource.
				113
				114	Args:
				115	project: string, Project ID for this request. (required)
				116	httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	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.
				118
				119	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.
				120
				121	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	122
				123	Returns:
				124	An object of the form:
				125
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	#
				128	# Google Compute Engine has three Operation resources:
				129	#
				130	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				131	#
				132	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				133	#
				134	# Operations can be global, regional or zonal.
				135	# - For global operations, use the `globalOperations` resource.
				136	# - For regional operations, use the `regionOperations` resource.
				137	# - For zonal operations, use the `zonalOperations` resource.
				138	#
				139	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				140	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				141	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				142	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				143	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				144	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				145	"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]	146	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	147	"code": "A String", # [Output Only] The error type identifier for this error.
				148	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				149	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	},
				151	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	},
				153	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				154	"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.
				155	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				156	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				157	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				158	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	159	"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]	160	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				161	"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.
				162	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				163	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				164	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				165	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				166	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				167	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				168	"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.
				169	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				170	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				171	{
				172	"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.
				173	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				174	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				175	{
				176	"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).
				177	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				178	},
				179	],
				180	"message": "A String", # [Output Only] A human-readable description of the warning code.
				181	},
				182	],
				183	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				184	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	185	</div>
				186
				187	<div class="method">
				188	<code class="details" id="get">get(project, httpHealthCheck)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	189	<pre>Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	190
				191	Args:
				192	project: string, Project ID for this request. (required)
				193	httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
				194
				195	Returns:
				196	An object of the form:
				197
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	198	{ # Represents a legacy HTTP Health Check resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	199	#
				200	# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
				201	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				202	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				203	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				204	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				205	"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
				206	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				207	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				208	"name": "A String", # Name of the resource. Provided by the client when the resource is created. 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.
				209	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				210	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				211	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				212	"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
				213	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				214	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	215	</div>
				216
				217	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	218	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	219	<pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request.
				220
				221	Args:
				222	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	223	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	224	The object takes the form of:
				225
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	226	{ # Represents a legacy HTTP Health Check resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	227	#
				228	# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
				229	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				230	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				231	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				232	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				233	"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
				234	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				235	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				236	"name": "A String", # Name of the resource. Provided by the client when the resource is created. 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.
				237	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				238	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				239	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				240	"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
				241	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				242	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	243
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	244	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.
				245
				246	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.
				247
				248	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	249
				250	Returns:
				251	An object of the form:
				252
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	253	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	254	#
				255	# Google Compute Engine has three Operation resources:
				256	#
				257	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				258	#
				259	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				260	#
				261	# Operations can be global, regional or zonal.
				262	# - For global operations, use the `globalOperations` resource.
				263	# - For regional operations, use the `regionOperations` resource.
				264	# - For zonal operations, use the `zonalOperations` resource.
				265	#
				266	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				267	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				268	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				269	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				270	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				271	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				272	"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]	273	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	274	"code": "A String", # [Output Only] The error type identifier for this error.
				275	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				276	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	277	},
				278	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	279	},
				280	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				281	"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.
				282	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				283	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				284	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				285	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	286	"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]	287	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				288	"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.
				289	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				290	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				291	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				292	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				293	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				294	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				295	"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.
				296	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				297	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				298	{
				299	"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.
				300	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				301	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				302	{
				303	"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).
				304	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				305	},
				306	],
				307	"message": "A String", # [Output Only] A human-readable description of the warning code.
				308	},
				309	],
				310	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				311	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	312	</div>
				313
				314	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	315	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	316	<pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
				317
				318	Args:
				319	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	320	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	321
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	322	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	323
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	324	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.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	325
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	326	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) ```
				327	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`)
				328	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				329
				330	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.
				331
				332	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				333	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]	334	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	335
				336	Returns:
				337	An object of the form:
				338
				339	{ # Contains a list of HttpHealthCheck resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	340	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				341	"items": [ # A list of HttpHealthCheck resources.
				342	{ # Represents a legacy HTTP Health Check resource.
				343	#
				344	# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
				345	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				346	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				347	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				348	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				349	"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
				350	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				351	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				352	"name": "A String", # Name of the resource. Provided by the client when the resource is created. 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.
				353	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				354	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				355	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				356	"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
				357	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				358	},
				359	],
				360	"kind": "compute#httpHealthCheckList", # Type of resource.
				361	"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.
				362	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				363	"warning": { # [Output Only] Informational warning message.
				364	"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.
				365	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				366	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				367	{
				368	"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).
				369	"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]	370	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	371	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	372	"message": "A String", # [Output Only] A human-readable description of the warning code.
				373	},
				374	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	375	</div>
				376
				377	<div class="method">
				378	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				379	<pre>Retrieves the next page of results.
				380
				381	Args:
				382	previous_request: The request for the previous page. (required)
				383	previous_response: The response from the request for the previous page. (required)
				384
				385	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	386	A request object that you can call 'execute()' on to request the next
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	387	page. Returns None if there are no more items in the collection.
				388	</pre>
				389	</div>
				390
				391	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	392	<code class="details" id="patch">patch(project, httpHealthCheck, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	393	<pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	394
				395	Args:
				396	project: string, Project ID for this request. (required)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	397	httpHealthCheck: string, Name of the HttpHealthCheck resource to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	398	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	399	The object takes the form of:
				400
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	401	{ # Represents a legacy HTTP Health Check resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	402	#
				403	# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
				404	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				405	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				406	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				407	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				408	"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
				409	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				410	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				411	"name": "A String", # Name of the resource. Provided by the client when the resource is created. 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.
				412	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				413	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				414	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				415	"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
				416	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				417	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	418
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	419	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.
				420
				421	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.
				422
				423	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	424
				425	Returns:
				426	An object of the form:
				427
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	428	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	429	#
				430	# Google Compute Engine has three Operation resources:
				431	#
				432	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				433	#
				434	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				435	#
				436	# Operations can be global, regional or zonal.
				437	# - For global operations, use the `globalOperations` resource.
				438	# - For regional operations, use the `regionOperations` resource.
				439	# - For zonal operations, use the `zonalOperations` resource.
				440	#
				441	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				442	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				443	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				444	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				445	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				446	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				447	"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]	448	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	449	"code": "A String", # [Output Only] The error type identifier for this error.
				450	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				451	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	452	},
				453	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	454	},
				455	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				456	"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.
				457	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				458	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				459	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				460	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	461	"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]	462	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				463	"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.
				464	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				465	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				466	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				467	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				468	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				469	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				470	"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.
				471	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				472	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				473	{
				474	"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.
				475	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				476	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				477	{
				478	"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).
				479	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				480	},
				481	],
				482	"message": "A String", # [Output Only] A human-readable description of the warning code.
				483	},
				484	],
				485	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				486	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	487	</div>
				488
				489	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	490	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	491	<pre>Returns permissions that a caller has on the specified resource.
				492
				493	Args:
				494	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	495	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]	496	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	497	The object takes the form of:
				498
				499	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	500	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				501	"A String",
				502	],
				503	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	504
				505
				506	Returns:
				507	An object of the form:
				508
				509	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	510	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				511	"A String",
				512	],
				513	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	514	</div>
				515
				516	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	517	<code class="details" id="update">update(project, httpHealthCheck, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	518	<pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
				519
				520	Args:
				521	project: string, Project ID for this request. (required)
				522	httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	523	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	524	The object takes the form of:
				525
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	526	{ # Represents a legacy HTTP Health Check resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	527	#
				528	# Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
				529	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				530	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				531	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				532	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				533	"host": "A String", # The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
				534	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				535	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				536	"name": "A String", # Name of the resource. Provided by the client when the resource is created. 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.
				537	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				538	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				539	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				540	"timeoutSec": 42, # How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
				541	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				542	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	543
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	544	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.
				545
				546	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.
				547
				548	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	549
				550	Returns:
				551	An object of the form:
				552
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	553	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	554	#
				555	# Google Compute Engine has three Operation resources:
				556	#
				557	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				558	#
				559	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				560	#
				561	# Operations can be global, regional or zonal.
				562	# - For global operations, use the `globalOperations` resource.
				563	# - For regional operations, use the `regionOperations` resource.
				564	# - For zonal operations, use the `zonalOperations` resource.
				565	#
				566	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				567	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				568	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				569	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				570	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				571	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				572	"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]	573	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	574	"code": "A String", # [Output Only] The error type identifier for this error.
				575	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				576	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	577	},
				578	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	579	},
				580	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				581	"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.
				582	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				583	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				584	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				585	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	586	"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]	587	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				588	"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.
				589	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				590	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				591	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				592	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				593	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				594	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				595	"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.
				596	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				597	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				598	{
				599	"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.
				600	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				601	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				602	{
				603	"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).
				604	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				605	},
				606	],
				607	"message": "A String", # [Output Only] A human-readable description of the warning code.
				608	},
				609	],
				610	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				611	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	612	</div>
				613
				614	</body></html>