Debian Codegraph @

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