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

blob: d0bc77c225f0dd7e1b6f80b0dee3f4fc6bf1ad0e [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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_v1.html">Compute Engine API</a> . <a href="compute_v1.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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	82	<p class="firstline">Deletes the specified HttpHealthCheck resource.</p>
				83	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	84	<code><a href="#get">get(project, httpHealthCheck, x__xgafv=None)</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>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	86	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	90	<code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[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">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	96	<code><a href="#patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=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>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	98	<p class="toc_element">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	99	<code><a href="#update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	100	<p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data included in the request.</p>
				101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	108	<code class="details" id="delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	109	<pre>Deletes the specified HttpHealthCheck resource.
				110
				111	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	112	project: string, Project ID for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	113	httpHealthCheck: string, Name of the HttpHealthCheck resource to delete. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	114	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).
				115	x__xgafv: string, V1 error format.
				116	Allowed values
				117	1 - v1 error format
				118	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	119
				120	Returns:
				121	An object of the form:
				122
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	123	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	124	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				125	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				126	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				127	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				128	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				129	"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]	130	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	131	"code": "A String", # [Output Only] The error type identifier for this error.
				132	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				133	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	},
				135	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	136	},
				137	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				138	"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.
				139	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				140	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				141	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				142	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	143	"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]	144	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				145	"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.
				146	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				147	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				148	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				149	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				150	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				151	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				152	"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.
				153	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				154	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				155	{
				156	"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]	157	"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]	158	{
				159	"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).
				160	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				161	},
				162	],
				163	"message": "A String", # [Output Only] A human-readable description of the warning code.
				164	},
				165	],
				166	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				167	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	168	</div>
				169
				170	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	171	<code class="details" id="get">get(project, httpHealthCheck, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	<pre>Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	173
				174	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	175	project: string, Project ID for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	176	httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	181
				182	Returns:
				183	An object of the form:
				184
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	185	{ # Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				187	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				188	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				189	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				190	"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.
				191	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				192	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				193	"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.
				194	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				195	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				196	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				197	"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.
				198	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				199	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	200	</div>
				201
				202	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	203	<code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	204	<pre>Creates a HttpHealthCheck resource in the specified project using the data included in the request.
				205
				206	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	207	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	208	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	209	The object takes the form of:
				210
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	211	{ # Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	212	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				213	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				214	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				215	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				216	"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.
				217	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				218	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				219	"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.
				220	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				221	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				222	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				223	"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.
				224	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				225	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	226
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	227	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).
				228	x__xgafv: string, V1 error format.
				229	Allowed values
				230	1 - v1 error format
				231	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	232
				233	Returns:
				234	An object of the form:
				235
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	236	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	237	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				238	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				239	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				240	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				241	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				242	"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]	243	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	244	"code": "A String", # [Output Only] The error type identifier for this error.
				245	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				246	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	247	},
				248	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	249	},
				250	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				251	"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.
				252	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				253	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				254	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				255	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	256	"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]	257	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				258	"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.
				259	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				260	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				261	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				262	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				263	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				264	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				265	"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.
				266	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				267	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				268	{
				269	"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]	270	"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]	271	{
				272	"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).
				273	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				274	},
				275	],
				276	"message": "A String", # [Output Only] A human-readable description of the warning code.
				277	},
				278	],
				279	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				280	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	281	</div>
				282
				283	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	284	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	285	<pre>Retrieves the list of HttpHealthCheck resources available to the specified project.
				286
				287	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	288	project: string, Project ID for this request. (required)
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	289	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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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]	290	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]	291	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]	292	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]	293	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]	294	x__xgafv: string, V1 error format.
				295	Allowed values
				296	1 - v1 error format
				297	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	298
				299	Returns:
				300	An object of the form:
				301
				302	{ # Contains a list of HttpHealthCheck resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	303	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				304	"items": [ # A list of HttpHealthCheck resources.
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	305	{ # Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	306	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				307	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				308	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				309	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				310	"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.
				311	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				312	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				313	"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.
				314	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				315	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				316	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				317	"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.
				318	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				319	},
				320	],
				321	"kind": "compute#httpHealthCheckList", # Type of resource.
				322	"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.
				323	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				324	"warning": { # [Output Only] Informational warning message.
				325	"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]	326	"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]	327	{
				328	"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).
				329	"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]	330	},
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	331	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	332	"message": "A String", # [Output Only] A human-readable description of the warning code.
				333	},
				334	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	335	</div>
				336
				337	<div class="method">
				338	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				339	<pre>Retrieves the next page of results.
				340
				341	Args:
				342	previous_request: The request for the previous page. (required)
				343	previous_response: The response from the request for the previous page. (required)
				344
				345	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	346	A request object that you can call 'execute()' on to request the next
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	347	page. Returns None if there are no more items in the collection.
				348	</pre>
				349	</div>
				350
				351	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	352	<code class="details" id="patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	353	<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.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	354
				355	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	356	project: string, Project ID for this request. (required)
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	357	httpHealthCheck: string, Name of the HttpHealthCheck resource to patch. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	358	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	359	The object takes the form of:
				360
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	361	{ # Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	362	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				363	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				364	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				365	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				366	"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.
				367	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				368	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				369	"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.
				370	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				371	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				372	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				373	"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.
				374	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				375	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	376
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	377	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).
				378	x__xgafv: string, V1 error format.
				379	Allowed values
				380	1 - v1 error format
				381	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	382
				383	Returns:
				384	An object of the form:
				385
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	386	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	387	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				388	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				389	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				390	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				391	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				392	"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]	393	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	394	"code": "A String", # [Output Only] The error type identifier for this error.
				395	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				396	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	397	},
				398	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	399	},
				400	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				401	"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.
				402	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				403	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				404	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				405	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	406	"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]	407	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				408	"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.
				409	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				410	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				411	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				412	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				413	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				414	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				415	"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.
				416	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				417	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				418	{
				419	"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]	420	"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]	421	{
				422	"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).
				423	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				424	},
				425	],
				426	"message": "A String", # [Output Only] A human-readable description of the warning code.
				427	},
				428	],
				429	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				430	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	431	</div>
				432
				433	<div class="method">
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	434	<code class="details" id="update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	435	<pre>Updates a HttpHealthCheck resource in the specified project using the data included in the request.
				436
				437	Args:
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	438	project: string, Project ID for this request. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	439	httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	440	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	441	The object takes the form of:
				442
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	443	{ # Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	444	"checkIntervalSec": 42, # How often (in seconds) to send a health check. The default value is 5 seconds.
				445	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				446	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				447	"healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
				448	"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.
				449	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				450	"kind": "compute#httpHealthCheck", # [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
				451	"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.
				452	"port": 42, # The TCP port number for the HTTP health check request. The default value is 80.
				453	"requestPath": "A String", # The request path of the HTTP health check request. The default value is /. This field does not support query parameters.
				454	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				455	"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.
				456	"unhealthyThreshold": 42, # A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
				457	}
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	458
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	459	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).
				460	x__xgafv: string, V1 error format.
				461	Allowed values
				462	1 - v1 error format
				463	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	464
				465	Returns:
				466	An object of the form:
				467
yoshi-code-bot	3659137	2021-06-16 00:22:06 -0700	[diff] [blame]	468	{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/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]	469	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				470	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				471	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				472	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				473	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				474	"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]	475	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	476	"code": "A String", # [Output Only] The error type identifier for this error.
				477	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				478	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	479	},
				480	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	481	},
				482	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				483	"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.
				484	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				485	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				486	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				487	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	488	"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]	489	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				490	"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.
				491	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				492	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				493	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				494	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				495	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				496	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				497	"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.
				498	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				499	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				500	{
				501	"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]	502	"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]	503	{
				504	"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).
				505	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				506	},
				507	],
				508	"message": "A String", # [Output Only] A human-readable description of the warning code.
				509	},
				510	],
				511	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				512	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	513	</div>
				514
				515	</body></html>