Debian Codegraph @

docs/dyn/compute_alpha.httpHealthChecks.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.httpHealthChecks.html">httpHealthChecks</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified HttpHealthCheck resource.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, httpHealthCheck, x__xgafv=None)</a></code></p>
85 <p class="firstline">Returns the specified HttpHealthCheck resource.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Creates a HttpHealthCheck resource in the specified project using the data</p>
89 <p class="toc_element">
90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves the list of HttpHealthCheck resources available to the specified</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data</p>
98 <p class="toc_element">
99 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101 <p class="toc_element">
102 <code><a href="#update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Updates a HttpHealthCheck resource in the specified project using the data</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108 </div>
109
110 <div class="method">
111 <code class="details" id="delete">delete(project, httpHealthCheck, requestId=None, x__xgafv=None)</code>
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)
117 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
118 that if you must retry your request, the server will know to ignore the
119 request if it has already been completed.
120
121 For example, consider a situation where you make an initial request and
122 the request times out. If you make the request again with the same
123 request ID, the server can check if original operation with the same
124 request ID was received, and if so, will ignore the second request. This
125 prevents clients from accidentally creating duplicate commitments.
126
127 The request ID must be
128 a valid UUID with the exception that zero UUID is not supported
129 (00000000-0000-0000-0000-000000000000).
130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135 Returns:
136 An object of the form:
137
138 { # Represents an Operation resource.
139 #
140 # Google Compute Engine has three Operation resources:
141 #
142 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
143 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
144 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
145 #
146 # You can use an operation resource to manage asynchronous API requests.
147 # For more information, readHandling
148 # API responses.
149 #
150 # Operations can be global, regional or zonal.
151 #
152 # - For global operations, use the `globalOperations`
153 # resource.
154 # - For regional operations, use the
155 # `regionOperations` resource.
156 # - For zonal operations, use
157 # the `zoneOperations` resource.
158 #
159 #
160 #
161 # For more information, read
162 # Global, Regional, and Zonal Resources.
163 #
164 # Note that completed Operation resources have a limited
165 # retention period.
166 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
167 # Not present otherwise.
168 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
169 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
170 # set when the operation is created.
171 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
172 # text format.
173 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
174 # this field will be populated.
175 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
176 # operation.
177 {
178 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
179 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
180 # details. There is a set of defined message types to use for providing
181 # details.The syntax depends on the error code. For example,
182 # QuotaExceededInfo will have details when the error code is
183 # QUOTA_EXCEEDED.
184 {
185 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
186 #
187 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
188 # is not enabled:
189 #
190 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
191 # &quot;domain&quot;: &quot;googleapis.com&quot;
192 # &quot;metadata&quot;: {
193 # &quot;resource&quot;: &quot;projects/123&quot;,
194 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
195 # }
196 # }
197 #
198 # This response indicates that the pubsub.googleapis.com API is not enabled.
199 #
200 # Example of an error that is returned when attempting to create a Spanner
201 # instance in a region that is out of stock:
202 #
203 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
204 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
205 # &quot;metadata&quot;: {
206 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
207 # }
208 # }
209 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
210 # is typically the registered service name of the tool or product that
211 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
212 # generated by some common infrastructure, the error domain must be a
213 # globally unique value that identifies the infrastructure. For Google API
214 # infrastructure, the error domain is &quot;googleapis.com&quot;.
215 &quot;metadatas&quot;: { # Additional structured details about this error.
216 #
217 # Keys must match a regular expression of `a-z+` but should
218 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
219 # length. When identifying the current value of an exceeded limit, the units
220 # should be contained in the key, not the value. For example, rather than
221 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
222 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
223 # instances that can be created in a single (batch) request.
224 &quot;a_key&quot;: &quot;A String&quot;,
225 },
226 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
227 # proximate cause of the error. Error reasons are unique within a particular
228 # domain of errors. This should be at most 63 characters and match a
229 # regular expression of `A-Z+[A-Z0-9]`, which represents
230 # UPPER_SNAKE_CASE.
231 },
232 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
233 #
234 # For example, if a quota check failed with an error indicating the calling
235 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
236 # directly to the right place in the developer console to flip the bit.
237 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
238 { # Describes a URL link.
239 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
240 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
241 },
242 ],
243 },
244 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
245 # which can be attached to an RPC error.
246 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
247 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
248 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
249 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
250 },
251 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
252 &quot;dimensions&quot;: { # The map holding related quota dimensions.
253 &quot;a_key&quot;: &quot;A String&quot;,
254 },
255 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
256 # type or metric.
257 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
258 # or metric.
259 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
260 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
261 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
262 },
263 },
264 ],
265 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
266 # This property is optional.
267 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
268 },
269 ],
270 },
271 &quot;getVersionOperationMetadata&quot;: {
272 &quot;inlineSbomInfo&quot;: {
273 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
274 # appropriate identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
278 # identifiers.
279 &quot;a_key&quot;: &quot;A String&quot;,
280 },
281 },
282 },
283 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
284 # message that was returned, such as `NOT FOUND`.
285 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
286 # status code that was returned. For example, a `404` means the
287 # resource was not found.
288 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
289 # defined by the server.
290 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
291 # This value is inRFC3339
292 # text format.
293 &quot;instancesBulkInsertOperationMetadata&quot;: {
294 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
295 # Example key: zones/us-central1-a
296 &quot;a_key&quot;: {
297 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
298 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
299 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
300 # error.
301 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
302 # if the flow is rolling forward or rolling back.
303 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
304 },
305 },
306 },
307 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
308 # Operation resources.
309 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
310 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
311 # group of operations results from a `bulkInsert` API request.
312 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
313 # `update`, or `delete`, and so on.
314 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
315 # There is no requirement that this be linear or support any granularity of
316 # operations. This should not be used to guess when the operation will be
317 # complete. This number should monotonically increase as the operation
318 # progresses.
319 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
320 # applicable when performing regional operations.
321 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
322 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
323 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
324 # this field will contain information on all underlying zonal actions and
325 # their state.
326 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
327 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
328 # Example key: zones/us-central1-a
329 &quot;a_key&quot;: {
330 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
331 # populated.
332 # different programming environments, including REST APIs and RPC APIs. It is
333 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
334 # three pieces of data: error code, error message, and error details.
335 #
336 # You can find out more about this error model and how to work with it in the
337 # [API Design Guide](https://cloud.google.com/apis/design/errors).
338 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
339 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
340 # message types for APIs to use.
341 {
342 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
343 },
344 ],
345 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
346 # user-facing error message should be localized and sent in the
347 # google.rpc.Status.details field, or localized by the client.
348 },
349 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
350 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
351 },
352 },
353 },
354 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
355 # This value is inRFC3339
356 # text format.
357 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
358 # following:
359 # `PENDING`, `RUNNING`, or `DONE`.
360 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
361 # operation.
362 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
363 # of the target resource.
364 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
365 # operations related to creating a snapshot, this points to the disk
366 # that the snapshot was created from.
367 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
368 # `[email protected]` or
369 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
370 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
371 # operation, this field will be populated.
372 {
373 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
374 # Engine returns NO_RESULTS_ON_PAGE if there
375 # are no results in the response.
376 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
377 # value format. For example:
378 #
379 # &quot;data&quot;: [
380 # {
381 # &quot;key&quot;: &quot;scope&quot;,
382 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
383 # }
384 {
385 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
386 # returned. For example, for warnings where there are no results in a list
387 # request for a particular zone, this key might be scope and
388 # the key value might be the zone name. Other examples might be a key
389 # indicating a deprecated resource and a suggested replacement, or a
390 # warning about invalid network settings (for example, if an instance
391 # attempts to perform IP forwarding but is not enabled for IP forwarding).
392 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
393 },
394 ],
395 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
396 },
397 ],
398 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
399 # applicable when performing per-zone operations.
400 }</pre>
401 </div>
402
403 <div class="method">
404 <code class="details" id="get">get(project, httpHealthCheck, x__xgafv=None)</code>
405 <pre>Returns the specified HttpHealthCheck resource.
406
407 Args:
408 project: string, Project ID for this request. (required)
409 httpHealthCheck: string, Name of the HttpHealthCheck resource to return. (required)
410 x__xgafv: string, V1 error format.
411 Allowed values
412 1 - v1 error format
413 2 - v2 error format
414
415 Returns:
416 An object of the form:
417
418 { # Represents a legacy HTTP Health Check resource.
419 #
420 # Legacy HTTP health checks are now only required by target pool-based network
421 # load balancers. For all other load balancers, including backend service-based
422 # network load balancers, and for managed instance group auto-healing, you must
423 # use modern (non-legacy) health checks.
424 #
425 # For more information, seeHealth checks
426 # overview.
427 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is5 seconds.
428 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
429 # text format.
430 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
431 # create the resource.
432 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this
433 # many consecutive successes. The default value is 2.
434 &quot;host&quot;: &quot;A String&quot;, # The value of the host header in the HTTP health check request. If left
435 # empty (default value), the public IP on behalf of which this health check
436 # is performed will be used.
437 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
438 # defined by the server.
439 &quot;kind&quot;: &quot;compute#httpHealthCheck&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.
440 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
441 # The name must be 1-63 characters long, and comply withRFC1035.
442 # Specifically, the name must be 1-63 characters long and match the regular
443 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
444 # character must be a lowercase letter, and all following characters must
445 # be a dash, lowercase letter, or digit, except the last character, which
446 # cannot be a dash.
447 &quot;port&quot;: 42, # The TCP port number for the HTTP health check request. The default value is80.
448 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is/. This field does not support query
449 # parameters. Must comply withRFC3986.
450 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
451 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
452 &quot;timeoutSec&quot;: 42, # How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have
453 # greater value than checkIntervalSec.
454 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this
455 # many consecutive failures. The default value is 2.
456 }</pre>
457 </div>
458
459 <div class="method">
460 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
461 <pre>Creates a HttpHealthCheck resource in the specified project using the data
462 included in the request.
463
464 Args:
465 project: string, Project ID for this request. (required)
466 body: object, The request body.
467 The object takes the form of:
468
469 { # Represents a legacy HTTP Health Check resource.
470 #
471 # Legacy HTTP health checks are now only required by target pool-based network
472 # load balancers. For all other load balancers, including backend service-based
473 # network load balancers, and for managed instance group auto-healing, you must
474 # use modern (non-legacy) health checks.
475 #
476 # For more information, seeHealth checks
477 # overview.
478 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is5 seconds.
479 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
480 # text format.
481 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
482 # create the resource.
483 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this
484 # many consecutive successes. The default value is 2.
485 &quot;host&quot;: &quot;A String&quot;, # The value of the host header in the HTTP health check request. If left
486 # empty (default value), the public IP on behalf of which this health check
487 # is performed will be used.
488 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
489 # defined by the server.
490 &quot;kind&quot;: &quot;compute#httpHealthCheck&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.
491 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
492 # The name must be 1-63 characters long, and comply withRFC1035.
493 # Specifically, the name must be 1-63 characters long and match the regular
494 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
495 # character must be a lowercase letter, and all following characters must
496 # be a dash, lowercase letter, or digit, except the last character, which
497 # cannot be a dash.
498 &quot;port&quot;: 42, # The TCP port number for the HTTP health check request. The default value is80.
499 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is/. This field does not support query
500 # parameters. Must comply withRFC3986.
501 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
502 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
503 &quot;timeoutSec&quot;: 42, # How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have
504 # greater value than checkIntervalSec.
505 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this
506 # many consecutive failures. The default value is 2.
507 }
508
509 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
510 that if you must retry your request, the server will know to ignore the
511 request if it has already been completed.
512
513 For example, consider a situation where you make an initial request and
514 the request times out. If you make the request again with the same
515 request ID, the server can check if original operation with the same
516 request ID was received, and if so, will ignore the second request. This
517 prevents clients from accidentally creating duplicate commitments.
518
519 The request ID must be
520 a valid UUID with the exception that zero UUID is not supported
521 (00000000-0000-0000-0000-000000000000).
522 x__xgafv: string, V1 error format.
523 Allowed values
524 1 - v1 error format
525 2 - v2 error format
526
527 Returns:
528 An object of the form:
529
530 { # Represents an Operation resource.
531 #
532 # Google Compute Engine has three Operation resources:
533 #
534 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
535 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
536 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
537 #
538 # You can use an operation resource to manage asynchronous API requests.
539 # For more information, readHandling
540 # API responses.
541 #
542 # Operations can be global, regional or zonal.
543 #
544 # - For global operations, use the `globalOperations`
545 # resource.
546 # - For regional operations, use the
547 # `regionOperations` resource.
548 # - For zonal operations, use
549 # the `zoneOperations` resource.
550 #
551 #
552 #
553 # For more information, read
554 # Global, Regional, and Zonal Resources.
555 #
556 # Note that completed Operation resources have a limited
557 # retention period.
558 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
559 # Not present otherwise.
560 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
561 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
562 # set when the operation is created.
563 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
564 # text format.
565 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
566 # this field will be populated.
567 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
568 # operation.
569 {
570 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
571 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
572 # details. There is a set of defined message types to use for providing
573 # details.The syntax depends on the error code. For example,
574 # QuotaExceededInfo will have details when the error code is
575 # QUOTA_EXCEEDED.
576 {
577 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
578 #
579 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
580 # is not enabled:
581 #
582 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
583 # &quot;domain&quot;: &quot;googleapis.com&quot;
584 # &quot;metadata&quot;: {
585 # &quot;resource&quot;: &quot;projects/123&quot;,
586 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
587 # }
588 # }
589 #
590 # This response indicates that the pubsub.googleapis.com API is not enabled.
591 #
592 # Example of an error that is returned when attempting to create a Spanner
593 # instance in a region that is out of stock:
594 #
595 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
596 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
597 # &quot;metadata&quot;: {
598 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
599 # }
600 # }
601 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
602 # is typically the registered service name of the tool or product that
603 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
604 # generated by some common infrastructure, the error domain must be a
605 # globally unique value that identifies the infrastructure. For Google API
606 # infrastructure, the error domain is &quot;googleapis.com&quot;.
607 &quot;metadatas&quot;: { # Additional structured details about this error.
608 #
609 # Keys must match a regular expression of `a-z+` but should
610 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
611 # length. When identifying the current value of an exceeded limit, the units
612 # should be contained in the key, not the value. For example, rather than
613 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
614 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
615 # instances that can be created in a single (batch) request.
616 &quot;a_key&quot;: &quot;A String&quot;,
617 },
618 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
619 # proximate cause of the error. Error reasons are unique within a particular
620 # domain of errors. This should be at most 63 characters and match a
621 # regular expression of `A-Z+[A-Z0-9]`, which represents
622 # UPPER_SNAKE_CASE.
623 },
624 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
625 #
626 # For example, if a quota check failed with an error indicating the calling
627 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
628 # directly to the right place in the developer console to flip the bit.
629 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
630 { # Describes a URL link.
631 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
632 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
633 },
634 ],
635 },
636 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
637 # which can be attached to an RPC error.
638 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
639 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
640 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
641 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
642 },
643 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
644 &quot;dimensions&quot;: { # The map holding related quota dimensions.
645 &quot;a_key&quot;: &quot;A String&quot;,
646 },
647 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
648 # type or metric.
649 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
650 # or metric.
651 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
652 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
653 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
654 },
655 },
656 ],
657 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
658 # This property is optional.
659 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
660 },
661 ],
662 },
663 &quot;getVersionOperationMetadata&quot;: {
664 &quot;inlineSbomInfo&quot;: {
665 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
666 # appropriate identifiers.
667 &quot;a_key&quot;: &quot;A String&quot;,
668 },
669 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
670 # identifiers.
671 &quot;a_key&quot;: &quot;A String&quot;,
672 },
673 },
674 },
675 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
676 # message that was returned, such as `NOT FOUND`.
677 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
678 # status code that was returned. For example, a `404` means the
679 # resource was not found.
680 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
681 # defined by the server.
682 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
683 # This value is inRFC3339
684 # text format.
685 &quot;instancesBulkInsertOperationMetadata&quot;: {
686 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
687 # Example key: zones/us-central1-a
688 &quot;a_key&quot;: {
689 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
690 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
691 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
692 # error.
693 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
694 # if the flow is rolling forward or rolling back.
695 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
696 },
697 },
698 },
699 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
700 # Operation resources.
701 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
702 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
703 # group of operations results from a `bulkInsert` API request.
704 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
705 # `update`, or `delete`, and so on.
706 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
707 # There is no requirement that this be linear or support any granularity of
708 # operations. This should not be used to guess when the operation will be
709 # complete. This number should monotonically increase as the operation
710 # progresses.
711 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
712 # applicable when performing regional operations.
713 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
714 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
715 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
716 # this field will contain information on all underlying zonal actions and
717 # their state.
718 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
719 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
720 # Example key: zones/us-central1-a
721 &quot;a_key&quot;: {
722 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
723 # populated.
724 # different programming environments, including REST APIs and RPC APIs. It is
725 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
726 # three pieces of data: error code, error message, and error details.
727 #
728 # You can find out more about this error model and how to work with it in the
729 # [API Design Guide](https://cloud.google.com/apis/design/errors).
730 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
731 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
732 # message types for APIs to use.
733 {
734 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
735 },
736 ],
737 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
738 # user-facing error message should be localized and sent in the
739 # google.rpc.Status.details field, or localized by the client.
740 },
741 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
742 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
743 },
744 },
745 },
746 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
747 # This value is inRFC3339
748 # text format.
749 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
750 # following:
751 # `PENDING`, `RUNNING`, or `DONE`.
752 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
753 # operation.
754 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
755 # of the target resource.
756 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
757 # operations related to creating a snapshot, this points to the disk
758 # that the snapshot was created from.
759 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
760 # `[email protected]` or
761 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
762 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
763 # operation, this field will be populated.
764 {
765 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
766 # Engine returns NO_RESULTS_ON_PAGE if there
767 # are no results in the response.
768 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
769 # value format. For example:
770 #
771 # &quot;data&quot;: [
772 # {
773 # &quot;key&quot;: &quot;scope&quot;,
774 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
775 # }
776 {
777 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
778 # returned. For example, for warnings where there are no results in a list
779 # request for a particular zone, this key might be scope and
780 # the key value might be the zone name. Other examples might be a key
781 # indicating a deprecated resource and a suggested replacement, or a
782 # warning about invalid network settings (for example, if an instance
783 # attempts to perform IP forwarding but is not enabled for IP forwarding).
784 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
785 },
786 ],
787 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
788 },
789 ],
790 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
791 # applicable when performing per-zone operations.
792 }</pre>
793 </div>
794
795 <div class="method">
796 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
797 <pre>Retrieves the list of HttpHealthCheck resources available to the specified
798 project.
799
800 Args:
801 project: string, Project ID for this request. (required)
802 filter: string, A filter expression that filters resources listed in the response. Most
803 Compute resources support two types of filter expressions:
804 expressions that support regular expressions and expressions that follow
805 API improvement proposal AIP-160.
806 These two types of filter expressions cannot be mixed in one request.
807
808 If you want to use AIP-160, your expression must specify the field name, an
809 operator, and the value that you want to use for filtering. The value
810 must be a string, a number, or a boolean. The operator
811 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
812
813 For example, if you are filtering Compute Engine instances, you can
814 exclude instances named `example-instance` by specifying
815 `name != example-instance`.
816
817 The `:*` comparison can be used to test whether a key has been defined.
818 For example, to find all objects with `owner` label use:
819 ```
820 labels.owner:*
821 ```
822
823 You can also filter nested fields. For example, you could specify
824 `scheduling.automaticRestart = false` to include instances only
825 if they are not scheduled for automatic restarts. You can use filtering
826 on nested fields to filter based onresource labels.
827
828 To filter on multiple expressions, provide each separate expression within
829 parentheses. For example:
830 ```
831 (scheduling.automaticRestart = true)
832 (cpuPlatform = &quot;Intel Skylake&quot;)
833 ```
834 By default, each expression is an `AND` expression. However, you
835 can include `AND` and `OR` expressions explicitly.
836 For example:
837 ```
838 (cpuPlatform = &quot;Intel Skylake&quot;) OR
839 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
840 (scheduling.automaticRestart = true)
841 ```
842
843 If you want to use a regular expression, use the `eq` (equal) or `ne`
844 (not equal) operator against a single un-parenthesized expression with or
845 without quotes or against multiple parenthesized expressions. Examples:
846
847 `fieldname eq unquoted literal`
848 `fieldname eq &#x27;single quoted literal&#x27;`
849 `fieldname eq &quot;double quoted literal&quot;`
850 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
851
852 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
853 The literal value must match the entire field.
854
855 For example, to filter for instances that do not end with name &quot;instance&quot;,
856 you would use `name ne .*instance`.
857
858 You cannot combine constraints on multiple fields using regular
859 expressions.
860 maxResults: integer, The maximum number of results per page that should be returned.
861 If the number of available results is larger than `maxResults`,
862 Compute Engine returns a `nextPageToken` that can be used to get
863 the next page of results in subsequent list requests. Acceptable values are
864 `0` to `500`, inclusive. (Default: `500`)
865 orderBy: string, Sorts list results by a certain order. By default, results
866 are returned in alphanumerical order based on the resource name.
867
868 You can also sort results in descending order based on the creation
869 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
870 results based on the `creationTimestamp` field in
871 reverse chronological order (newest result first). Use this to sort
872 resources like operations so that the newest operation is returned first.
873
874 Currently, only sorting by `name` or
875 `creationTimestamp desc` is supported.
876 pageToken: string, Specifies a page token to use. Set `pageToken` to the
877 `nextPageToken` returned by a previous list request to get
878 the next page of results.
879 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
880 of failure. The default value is false.
881
882 For example, when partial success behavior is enabled, aggregatedList for a
883 single zone scope either returns all resources in the zone or no resources,
884 with an error code.
885 x__xgafv: string, V1 error format.
886 Allowed values
887 1 - v1 error format
888 2 - v2 error format
889
890 Returns:
891 An object of the form:
892
893 { # Contains a list of HttpHealthCheck resources.
894 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
895 &quot;items&quot;: [ # A list of HttpHealthCheck resources.
896 { # Represents a legacy HTTP Health Check resource.
897 #
898 # Legacy HTTP health checks are now only required by target pool-based network
899 # load balancers. For all other load balancers, including backend service-based
900 # network load balancers, and for managed instance group auto-healing, you must
901 # use modern (non-legacy) health checks.
902 #
903 # For more information, seeHealth checks
904 # overview.
905 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is5 seconds.
906 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
907 # text format.
908 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
909 # create the resource.
910 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this
911 # many consecutive successes. The default value is 2.
912 &quot;host&quot;: &quot;A String&quot;, # The value of the host header in the HTTP health check request. If left
913 # empty (default value), the public IP on behalf of which this health check
914 # is performed will be used.
915 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
916 # defined by the server.
917 &quot;kind&quot;: &quot;compute#httpHealthCheck&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.
918 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
919 # The name must be 1-63 characters long, and comply withRFC1035.
920 # Specifically, the name must be 1-63 characters long and match the regular
921 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
922 # character must be a lowercase letter, and all following characters must
923 # be a dash, lowercase letter, or digit, except the last character, which
924 # cannot be a dash.
925 &quot;port&quot;: 42, # The TCP port number for the HTTP health check request. The default value is80.
926 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is/. This field does not support query
927 # parameters. Must comply withRFC3986.
928 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
929 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
930 &quot;timeoutSec&quot;: 42, # How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have
931 # greater value than checkIntervalSec.
932 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this
933 # many consecutive failures. The default value is 2.
934 },
935 ],
936 &quot;kind&quot;: &quot;compute#httpHealthCheckList&quot;, # Output only. Type of resource.
937 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
938 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
939 # the query parameter pageToken in the next list request.
940 # Subsequent list requests will have their own nextPageToken to
941 # continue paging through the results.
942 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
943 &quot;warning&quot;: { # [Output Only] Informational warning message.
944 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
945 # Engine returns NO_RESULTS_ON_PAGE if there
946 # are no results in the response.
947 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
948 # value format. For example:
949 #
950 # &quot;data&quot;: [
951 # {
952 # &quot;key&quot;: &quot;scope&quot;,
953 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
954 # }
955 {
956 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
957 # returned. For example, for warnings where there are no results in a list
958 # request for a particular zone, this key might be scope and
959 # the key value might be the zone name. Other examples might be a key
960 # indicating a deprecated resource and a suggested replacement, or a
961 # warning about invalid network settings (for example, if an instance
962 # attempts to perform IP forwarding but is not enabled for IP forwarding).
963 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
964 },
965 ],
966 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
967 },
968 }</pre>
969 </div>
970
971 <div class="method">
972 <code class="details" id="list_next">list_next()</code>
973 <pre>Retrieves the next page of results.
974
975 Args:
976 previous_request: The request for the previous page. (required)
977 previous_response: The response from the request for the previous page. (required)
978
979 Returns:
980 A request object that you can call &#x27;execute()&#x27; on to request the next
981 page. Returns None if there are no more items in the collection.
982 </pre>
983 </div>
984
985 <div class="method">
986 <code class="details" id="patch">patch(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code>
987 <pre>Updates a HttpHealthCheck resource in the specified project using the data
988 included in the request. This method supportsPATCH
989 semantics and uses theJSON merge
990 patch format and processing rules.
991
992 Args:
993 project: string, Project ID for this request. (required)
994 httpHealthCheck: string, Name of the HttpHealthCheck resource to patch. (required)
995 body: object, The request body.
996 The object takes the form of:
997
998 { # Represents a legacy HTTP Health Check resource.
999 #
1000 # Legacy HTTP health checks are now only required by target pool-based network
1001 # load balancers. For all other load balancers, including backend service-based
1002 # network load balancers, and for managed instance group auto-healing, you must
1003 # use modern (non-legacy) health checks.
1004 #
1005 # For more information, seeHealth checks
1006 # overview.
1007 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is5 seconds.
1008 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1009 # text format.
1010 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1011 # create the resource.
1012 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this
1013 # many consecutive successes. The default value is 2.
1014 &quot;host&quot;: &quot;A String&quot;, # The value of the host header in the HTTP health check request. If left
1015 # empty (default value), the public IP on behalf of which this health check
1016 # is performed will be used.
1017 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1018 # defined by the server.
1019 &quot;kind&quot;: &quot;compute#httpHealthCheck&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.
1020 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1021 # The name must be 1-63 characters long, and comply withRFC1035.
1022 # Specifically, the name must be 1-63 characters long and match the regular
1023 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1024 # character must be a lowercase letter, and all following characters must
1025 # be a dash, lowercase letter, or digit, except the last character, which
1026 # cannot be a dash.
1027 &quot;port&quot;: 42, # The TCP port number for the HTTP health check request. The default value is80.
1028 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is/. This field does not support query
1029 # parameters. Must comply withRFC3986.
1030 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1031 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1032 &quot;timeoutSec&quot;: 42, # How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have
1033 # greater value than checkIntervalSec.
1034 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this
1035 # many consecutive failures. The default value is 2.
1036 }
1037
1038 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1039 that if you must retry your request, the server will know to ignore the
1040 request if it has already been completed.
1041
1042 For example, consider a situation where you make an initial request and
1043 the request times out. If you make the request again with the same
1044 request ID, the server can check if original operation with the same
1045 request ID was received, and if so, will ignore the second request. This
1046 prevents clients from accidentally creating duplicate commitments.
1047
1048 The request ID must be
1049 a valid UUID with the exception that zero UUID is not supported
1050 (00000000-0000-0000-0000-000000000000).
1051 x__xgafv: string, V1 error format.
1052 Allowed values
1053 1 - v1 error format
1054 2 - v2 error format
1055
1056 Returns:
1057 An object of the form:
1058
1059 { # Represents an Operation resource.
1060 #
1061 # Google Compute Engine has three Operation resources:
1062 #
1063 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1064 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1065 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1066 #
1067 # You can use an operation resource to manage asynchronous API requests.
1068 # For more information, readHandling
1069 # API responses.
1070 #
1071 # Operations can be global, regional or zonal.
1072 #
1073 # - For global operations, use the `globalOperations`
1074 # resource.
1075 # - For regional operations, use the
1076 # `regionOperations` resource.
1077 # - For zonal operations, use
1078 # the `zoneOperations` resource.
1079 #
1080 #
1081 #
1082 # For more information, read
1083 # Global, Regional, and Zonal Resources.
1084 #
1085 # Note that completed Operation resources have a limited
1086 # retention period.
1087 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1088 # Not present otherwise.
1089 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1090 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1091 # set when the operation is created.
1092 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1093 # text format.
1094 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1095 # this field will be populated.
1096 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1097 # operation.
1098 {
1099 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1100 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1101 # details. There is a set of defined message types to use for providing
1102 # details.The syntax depends on the error code. For example,
1103 # QuotaExceededInfo will have details when the error code is
1104 # QUOTA_EXCEEDED.
1105 {
1106 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1107 #
1108 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1109 # is not enabled:
1110 #
1111 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1112 # &quot;domain&quot;: &quot;googleapis.com&quot;
1113 # &quot;metadata&quot;: {
1114 # &quot;resource&quot;: &quot;projects/123&quot;,
1115 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1116 # }
1117 # }
1118 #
1119 # This response indicates that the pubsub.googleapis.com API is not enabled.
1120 #
1121 # Example of an error that is returned when attempting to create a Spanner
1122 # instance in a region that is out of stock:
1123 #
1124 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1125 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1126 # &quot;metadata&quot;: {
1127 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1128 # }
1129 # }
1130 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1131 # is typically the registered service name of the tool or product that
1132 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1133 # generated by some common infrastructure, the error domain must be a
1134 # globally unique value that identifies the infrastructure. For Google API
1135 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1136 &quot;metadatas&quot;: { # Additional structured details about this error.
1137 #
1138 # Keys must match a regular expression of `a-z+` but should
1139 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1140 # length. When identifying the current value of an exceeded limit, the units
1141 # should be contained in the key, not the value. For example, rather than
1142 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1143 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1144 # instances that can be created in a single (batch) request.
1145 &quot;a_key&quot;: &quot;A String&quot;,
1146 },
1147 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1148 # proximate cause of the error. Error reasons are unique within a particular
1149 # domain of errors. This should be at most 63 characters and match a
1150 # regular expression of `A-Z+[A-Z0-9]`, which represents
1151 # UPPER_SNAKE_CASE.
1152 },
1153 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1154 #
1155 # For example, if a quota check failed with an error indicating the calling
1156 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1157 # directly to the right place in the developer console to flip the bit.
1158 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1159 { # Describes a URL link.
1160 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1161 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1162 },
1163 ],
1164 },
1165 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1166 # which can be attached to an RPC error.
1167 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1168 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1169 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1170 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1171 },
1172 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1173 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1174 &quot;a_key&quot;: &quot;A String&quot;,
1175 },
1176 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1177 # type or metric.
1178 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1179 # or metric.
1180 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1181 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1182 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1183 },
1184 },
1185 ],
1186 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1187 # This property is optional.
1188 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1189 },
1190 ],
1191 },
1192 &quot;getVersionOperationMetadata&quot;: {
1193 &quot;inlineSbomInfo&quot;: {
1194 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1195 # appropriate identifiers.
1196 &quot;a_key&quot;: &quot;A String&quot;,
1197 },
1198 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1199 # identifiers.
1200 &quot;a_key&quot;: &quot;A String&quot;,
1201 },
1202 },
1203 },
1204 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1205 # message that was returned, such as `NOT FOUND`.
1206 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1207 # status code that was returned. For example, a `404` means the
1208 # resource was not found.
1209 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1210 # defined by the server.
1211 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1212 # This value is inRFC3339
1213 # text format.
1214 &quot;instancesBulkInsertOperationMetadata&quot;: {
1215 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1216 # Example key: zones/us-central1-a
1217 &quot;a_key&quot;: {
1218 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1219 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1220 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1221 # error.
1222 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1223 # if the flow is rolling forward or rolling back.
1224 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1225 },
1226 },
1227 },
1228 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1229 # Operation resources.
1230 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1231 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1232 # group of operations results from a `bulkInsert` API request.
1233 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1234 # `update`, or `delete`, and so on.
1235 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1236 # There is no requirement that this be linear or support any granularity of
1237 # operations. This should not be used to guess when the operation will be
1238 # complete. This number should monotonically increase as the operation
1239 # progresses.
1240 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1241 # applicable when performing regional operations.
1242 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1243 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1244 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1245 # this field will contain information on all underlying zonal actions and
1246 # their state.
1247 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1248 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1249 # Example key: zones/us-central1-a
1250 &quot;a_key&quot;: {
1251 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1252 # populated.
1253 # different programming environments, including REST APIs and RPC APIs. It is
1254 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1255 # three pieces of data: error code, error message, and error details.
1256 #
1257 # You can find out more about this error model and how to work with it in the
1258 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1259 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1260 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1261 # message types for APIs to use.
1262 {
1263 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1264 },
1265 ],
1266 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1267 # user-facing error message should be localized and sent in the
1268 # google.rpc.Status.details field, or localized by the client.
1269 },
1270 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1271 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1272 },
1273 },
1274 },
1275 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1276 # This value is inRFC3339
1277 # text format.
1278 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1279 # following:
1280 # `PENDING`, `RUNNING`, or `DONE`.
1281 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1282 # operation.
1283 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1284 # of the target resource.
1285 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1286 # operations related to creating a snapshot, this points to the disk
1287 # that the snapshot was created from.
1288 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1289 # `[email protected]` or
1290 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1291 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1292 # operation, this field will be populated.
1293 {
1294 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1295 # Engine returns NO_RESULTS_ON_PAGE if there
1296 # are no results in the response.
1297 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1298 # value format. For example:
1299 #
1300 # &quot;data&quot;: [
1301 # {
1302 # &quot;key&quot;: &quot;scope&quot;,
1303 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1304 # }
1305 {
1306 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1307 # returned. For example, for warnings where there are no results in a list
1308 # request for a particular zone, this key might be scope and
1309 # the key value might be the zone name. Other examples might be a key
1310 # indicating a deprecated resource and a suggested replacement, or a
1311 # warning about invalid network settings (for example, if an instance
1312 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1313 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1314 },
1315 ],
1316 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1317 },
1318 ],
1319 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1320 # applicable when performing per-zone operations.
1321 }</pre>
1322 </div>
1323
1324 <div class="method">
1325 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
1326 <pre>Returns permissions that a caller has on the specified resource.
1327
1328 Args:
1329 project: string, Project ID for this request. (required)
1330 resource: string, Name or id of the resource for this request. (required)
1331 body: object, The request body.
1332 The object takes the form of:
1333
1334 {
1335 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
1336 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
1337 &quot;A String&quot;,
1338 ],
1339 }
1340
1341 x__xgafv: string, V1 error format.
1342 Allowed values
1343 1 - v1 error format
1344 2 - v2 error format
1345
1346 Returns:
1347 An object of the form:
1348
1349 {
1350 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1351 # allowed.
1352 &quot;A String&quot;,
1353 ],
1354 }</pre>
1355 </div>
1356
1357 <div class="method">
1358 <code class="details" id="update">update(project, httpHealthCheck, body=None, requestId=None, x__xgafv=None)</code>
1359 <pre>Updates a HttpHealthCheck resource in the specified project using the data
1360 included in the request.
1361
1362 Args:
1363 project: string, Project ID for this request. (required)
1364 httpHealthCheck: string, Name of the HttpHealthCheck resource to update. (required)
1365 body: object, The request body.
1366 The object takes the form of:
1367
1368 { # Represents a legacy HTTP Health Check resource.
1369 #
1370 # Legacy HTTP health checks are now only required by target pool-based network
1371 # load balancers. For all other load balancers, including backend service-based
1372 # network load balancers, and for managed instance group auto-healing, you must
1373 # use modern (non-legacy) health checks.
1374 #
1375 # For more information, seeHealth checks
1376 # overview.
1377 &quot;checkIntervalSec&quot;: 42, # How often (in seconds) to send a health check. The default value is5 seconds.
1378 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp inRFC3339
1379 # text format.
1380 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1381 # create the resource.
1382 &quot;healthyThreshold&quot;: 42, # A so-far unhealthy instance will be marked healthy after this
1383 # many consecutive successes. The default value is 2.
1384 &quot;host&quot;: &quot;A String&quot;, # The value of the host header in the HTTP health check request. If left
1385 # empty (default value), the public IP on behalf of which this health check
1386 # is performed will be used.
1387 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
1388 # defined by the server.
1389 &quot;kind&quot;: &quot;compute#httpHealthCheck&quot;, # Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.
1390 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1391 # The name must be 1-63 characters long, and comply withRFC1035.
1392 # Specifically, the name must be 1-63 characters long and match the regular
1393 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1394 # character must be a lowercase letter, and all following characters must
1395 # be a dash, lowercase letter, or digit, except the last character, which
1396 # cannot be a dash.
1397 &quot;port&quot;: 42, # The TCP port number for the HTTP health check request. The default value is80.
1398 &quot;requestPath&quot;: &quot;A String&quot;, # The request path of the HTTP health check request. The default value is/. This field does not support query
1399 # parameters. Must comply withRFC3986.
1400 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1401 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1402 &quot;timeoutSec&quot;: 42, # How long (in seconds) to wait before claiming failure. The default value is5 seconds. It is invalid for timeoutSec to have
1403 # greater value than checkIntervalSec.
1404 &quot;unhealthyThreshold&quot;: 42, # A so-far healthy instance will be marked unhealthy after this
1405 # many consecutive failures. The default value is 2.
1406 }
1407
1408 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1409 that if you must retry your request, the server will know to ignore the
1410 request if it has already been completed.
1411
1412 For example, consider a situation where you make an initial request and
1413 the request times out. If you make the request again with the same
1414 request ID, the server can check if original operation with the same
1415 request ID was received, and if so, will ignore the second request. This
1416 prevents clients from accidentally creating duplicate commitments.
1417
1418 The request ID must be
1419 a valid UUID with the exception that zero UUID is not supported
1420 (00000000-0000-0000-0000-000000000000).
1421 x__xgafv: string, V1 error format.
1422 Allowed values
1423 1 - v1 error format
1424 2 - v2 error format
1425
1426 Returns:
1427 An object of the form:
1428
1429 { # Represents an Operation resource.
1430 #
1431 # Google Compute Engine has three Operation resources:
1432 #
1433 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1434 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1435 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1436 #
1437 # You can use an operation resource to manage asynchronous API requests.
1438 # For more information, readHandling
1439 # API responses.
1440 #
1441 # Operations can be global, regional or zonal.
1442 #
1443 # - For global operations, use the `globalOperations`
1444 # resource.
1445 # - For regional operations, use the
1446 # `regionOperations` resource.
1447 # - For zonal operations, use
1448 # the `zoneOperations` resource.
1449 #
1450 #
1451 #
1452 # For more information, read
1453 # Global, Regional, and Zonal Resources.
1454 #
1455 # Note that completed Operation resources have a limited
1456 # retention period.
1457 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1458 # Not present otherwise.
1459 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1460 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1461 # set when the operation is created.
1462 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1463 # text format.
1464 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1465 # this field will be populated.
1466 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1467 # operation.
1468 {
1469 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1470 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1471 # details. There is a set of defined message types to use for providing
1472 # details.The syntax depends on the error code. For example,
1473 # QuotaExceededInfo will have details when the error code is
1474 # QUOTA_EXCEEDED.
1475 {
1476 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1477 #
1478 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1479 # is not enabled:
1480 #
1481 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1482 # &quot;domain&quot;: &quot;googleapis.com&quot;
1483 # &quot;metadata&quot;: {
1484 # &quot;resource&quot;: &quot;projects/123&quot;,
1485 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1486 # }
1487 # }
1488 #
1489 # This response indicates that the pubsub.googleapis.com API is not enabled.
1490 #
1491 # Example of an error that is returned when attempting to create a Spanner
1492 # instance in a region that is out of stock:
1493 #
1494 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1495 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1496 # &quot;metadata&quot;: {
1497 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1498 # }
1499 # }
1500 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1501 # is typically the registered service name of the tool or product that
1502 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1503 # generated by some common infrastructure, the error domain must be a
1504 # globally unique value that identifies the infrastructure. For Google API
1505 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1506 &quot;metadatas&quot;: { # Additional structured details about this error.
1507 #
1508 # Keys must match a regular expression of `a-z+` but should
1509 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1510 # length. When identifying the current value of an exceeded limit, the units
1511 # should be contained in the key, not the value. For example, rather than
1512 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1513 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1514 # instances that can be created in a single (batch) request.
1515 &quot;a_key&quot;: &quot;A String&quot;,
1516 },
1517 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1518 # proximate cause of the error. Error reasons are unique within a particular
1519 # domain of errors. This should be at most 63 characters and match a
1520 # regular expression of `A-Z+[A-Z0-9]`, which represents
1521 # UPPER_SNAKE_CASE.
1522 },
1523 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1524 #
1525 # For example, if a quota check failed with an error indicating the calling
1526 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1527 # directly to the right place in the developer console to flip the bit.
1528 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1529 { # Describes a URL link.
1530 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1531 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1532 },
1533 ],
1534 },
1535 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1536 # which can be attached to an RPC error.
1537 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1538 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1539 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1540 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1541 },
1542 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1543 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1544 &quot;a_key&quot;: &quot;A String&quot;,
1545 },
1546 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1547 # type or metric.
1548 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1549 # or metric.
1550 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1551 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1552 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1553 },
1554 },
1555 ],
1556 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1557 # This property is optional.
1558 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1559 },
1560 ],
1561 },
1562 &quot;getVersionOperationMetadata&quot;: {
1563 &quot;inlineSbomInfo&quot;: {
1564 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1565 # appropriate identifiers.
1566 &quot;a_key&quot;: &quot;A String&quot;,
1567 },
1568 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1569 # identifiers.
1570 &quot;a_key&quot;: &quot;A String&quot;,
1571 },
1572 },
1573 },
1574 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1575 # message that was returned, such as `NOT FOUND`.
1576 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1577 # status code that was returned. For example, a `404` means the
1578 # resource was not found.
1579 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1580 # defined by the server.
1581 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1582 # This value is inRFC3339
1583 # text format.
1584 &quot;instancesBulkInsertOperationMetadata&quot;: {
1585 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1586 # Example key: zones/us-central1-a
1587 &quot;a_key&quot;: {
1588 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1589 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1590 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1591 # error.
1592 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1593 # if the flow is rolling forward or rolling back.
1594 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1595 },
1596 },
1597 },
1598 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1599 # Operation resources.
1600 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1601 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1602 # group of operations results from a `bulkInsert` API request.
1603 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1604 # `update`, or `delete`, and so on.
1605 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1606 # There is no requirement that this be linear or support any granularity of
1607 # operations. This should not be used to guess when the operation will be
1608 # complete. This number should monotonically increase as the operation
1609 # progresses.
1610 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1611 # applicable when performing regional operations.
1612 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1613 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1614 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1615 # this field will contain information on all underlying zonal actions and
1616 # their state.
1617 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1618 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1619 # Example key: zones/us-central1-a
1620 &quot;a_key&quot;: {
1621 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
1622 # populated.
1623 # different programming environments, including REST APIs and RPC APIs. It is
1624 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1625 # three pieces of data: error code, error message, and error details.
1626 #
1627 # You can find out more about this error model and how to work with it in the
1628 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1629 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1630 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1631 # message types for APIs to use.
1632 {
1633 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1634 },
1635 ],
1636 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1637 # user-facing error message should be localized and sent in the
1638 # google.rpc.Status.details field, or localized by the client.
1639 },
1640 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1641 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1642 },
1643 },
1644 },
1645 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1646 # This value is inRFC3339
1647 # text format.
1648 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1649 # following:
1650 # `PENDING`, `RUNNING`, or `DONE`.
1651 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1652 # operation.
1653 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1654 # of the target resource.
1655 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1656 # operations related to creating a snapshot, this points to the disk
1657 # that the snapshot was created from.
1658 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1659 # `[email protected]` or
1660 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1661 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1662 # operation, this field will be populated.
1663 {
1664 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1665 # Engine returns NO_RESULTS_ON_PAGE if there
1666 # are no results in the response.
1667 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1668 # value format. For example:
1669 #
1670 # &quot;data&quot;: [
1671 # {
1672 # &quot;key&quot;: &quot;scope&quot;,
1673 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1674 # }
1675 {
1676 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1677 # returned. For example, for warnings where there are no results in a list
1678 # request for a particular zone, this key might be scope and
1679 # the key value might be the zone name. Other examples might be a key
1680 # indicating a deprecated resource and a suggested replacement, or a
1681 # warning about invalid network settings (for example, if an instance
1682 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1683 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1684 },
1685 ],
1686 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1687 },
1688 ],
1689 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1690 # applicable when performing per-zone operations.
1691 }</pre>
1692 </div>
1693
1694 </body></html>