Debian Codegraph @

docs/dyn/compute_beta.regionOperations.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.regionOperations.html">regionOperations</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, region, operation, x__xgafv=None)</a></code></p>
82 <p class="firstline">Deletes the specified region-specific Operations resource.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(project, region, operation, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves the specified region-specific Operations resource.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Retrieves a list of Operation resources contained within</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#wait">wait(project, region, operation, x__xgafv=None)</a></code></p>
94 <p class="firstline">Waits for the specified Operation resource to return as `DONE`</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="delete">delete(project, region, operation, x__xgafv=None)</code>
103 <pre>Deletes the specified region-specific Operations resource.
104
105 Args:
106 project: string, Project ID for this request. (required)
107 region: string, Name of the region for this request. (required)
108 operation: string, Name of the Operations resource to delete, or its unique numeric
109 identifier. (required)
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114 </pre>
115 </div>
116
117 <div class="method">
118 <code class="details" id="get">get(project, region, operation, x__xgafv=None)</code>
119 <pre>Retrieves the specified region-specific Operations resource.
120
121 Args:
122 project: string, Project ID for this request. (required)
123 region: string, Name of the region for this request. (required)
124 operation: string, Name of the Operations resource to return, or its unique numeric
125 identifier. (required)
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # Represents an Operation resource.
135 #
136 # Google Compute Engine has three Operation resources:
137 #
138 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
139 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
140 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
141 #
142 # You can use an operation resource to manage asynchronous API requests.
143 # For more information, readHandling
144 # API responses.
145 #
146 # Operations can be global, regional or zonal.
147 #
148 # - For global operations, use the `globalOperations`
149 # resource.
150 # - For regional operations, use the
151 # `regionOperations` resource.
152 # - For zonal operations, use
153 # the `zoneOperations` resource.
154 #
155 #
156 #
157 # For more information, read
158 # Global, Regional, and Zonal Resources.
159 #
160 # Note that completed Operation resources have a limited
161 # retention period.
162 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
163 # Not present otherwise.
164 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
165 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
166 # set when the operation is created.
167 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
168 # text format.
169 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
170 # this field will be populated.
171 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
172 # operation.
173 {
174 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
175 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
176 # details. There is a set of defined message types to use for providing
177 # details.The syntax depends on the error code. For example,
178 # QuotaExceededInfo will have details when the error code is
179 # QUOTA_EXCEEDED.
180 {
181 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
182 #
183 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
184 # is not enabled:
185 #
186 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
187 # &quot;domain&quot;: &quot;googleapis.com&quot;
188 # &quot;metadata&quot;: {
189 # &quot;resource&quot;: &quot;projects/123&quot;,
190 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
191 # }
192 # }
193 #
194 # This response indicates that the pubsub.googleapis.com API is not enabled.
195 #
196 # Example of an error that is returned when attempting to create a Spanner
197 # instance in a region that is out of stock:
198 #
199 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
200 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
201 # &quot;metadata&quot;: {
202 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
203 # }
204 # }
205 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
206 # is typically the registered service name of the tool or product that
207 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
208 # generated by some common infrastructure, the error domain must be a
209 # globally unique value that identifies the infrastructure. For Google API
210 # infrastructure, the error domain is &quot;googleapis.com&quot;.
211 &quot;metadatas&quot;: { # Additional structured details about this error.
212 #
213 # Keys must match a regular expression of `a-z+` but should
214 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
215 # length. When identifying the current value of an exceeded limit, the units
216 # should be contained in the key, not the value. For example, rather than
217 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
218 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
219 # instances that can be created in a single (batch) request.
220 &quot;a_key&quot;: &quot;A String&quot;,
221 },
222 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
223 # proximate cause of the error. Error reasons are unique within a particular
224 # domain of errors. This should be at most 63 characters and match a
225 # regular expression of `A-Z+[A-Z0-9]`, which represents
226 # UPPER_SNAKE_CASE.
227 },
228 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
229 #
230 # For example, if a quota check failed with an error indicating the calling
231 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
232 # directly to the right place in the developer console to flip the bit.
233 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
234 { # Describes a URL link.
235 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
236 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
237 },
238 ],
239 },
240 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
241 # which can be attached to an RPC error.
242 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
243 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
244 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
245 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
246 },
247 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
248 &quot;dimensions&quot;: { # The map holding related quota dimensions.
249 &quot;a_key&quot;: &quot;A String&quot;,
250 },
251 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
252 # type or metric.
253 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
254 # or metric.
255 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
256 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
257 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
258 },
259 },
260 ],
261 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
262 # This property is optional.
263 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
264 },
265 ],
266 },
267 &quot;getVersionOperationMetadata&quot;: {
268 &quot;inlineSbomInfo&quot;: {
269 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
270 # appropriate identifiers.
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
274 # identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 },
278 },
279 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
280 # message that was returned, such as `NOT FOUND`.
281 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
282 # status code that was returned. For example, a `404` means the
283 # resource was not found.
284 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
285 # defined by the server.
286 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
287 # This value is inRFC3339
288 # text format.
289 &quot;instancesBulkInsertOperationMetadata&quot;: {
290 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
291 # Example key: zones/us-central1-a
292 &quot;a_key&quot;: {
293 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
294 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
295 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
296 # error.
297 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
298 # if the flow is rolling forward or rolling back.
299 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
300 },
301 },
302 },
303 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
304 # Operation resources.
305 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
306 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
307 # group of operations results from a `bulkInsert` API request.
308 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
309 # `update`, or `delete`, and so on.
310 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
311 # There is no requirement that this be linear or support any granularity of
312 # operations. This should not be used to guess when the operation will be
313 # complete. This number should monotonically increase as the operation
314 # progresses.
315 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
316 # applicable when performing regional operations.
317 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
318 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
319 # this field will contain information on all underlying zonal actions and
320 # their state.
321 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
322 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
323 # Example key: zones/us-central1-a
324 &quot;a_key&quot;: {
325 &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
326 # populated.
327 # different programming environments, including REST APIs and RPC APIs. It is
328 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
329 # three pieces of data: error code, error message, and error details.
330 #
331 # You can find out more about this error model and how to work with it in the
332 # [API Design Guide](https://cloud.google.com/apis/design/errors).
333 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
334 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
335 # message types for APIs to use.
336 {
337 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
338 },
339 ],
340 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
341 # user-facing error message should be localized and sent in the
342 # google.rpc.Status.details field, or localized by the client.
343 },
344 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
345 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
346 },
347 },
348 },
349 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
350 # This value is inRFC3339
351 # text format.
352 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
353 # following:
354 # `PENDING`, `RUNNING`, or `DONE`.
355 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
356 # operation.
357 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
358 # of the target resource.
359 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
360 # operations related to creating a snapshot, this points to the disk
361 # that the snapshot was created from.
362 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
363 # `[email protected]` or
364 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
365 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
366 # operation, this field will be populated.
367 {
368 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
369 # Engine returns NO_RESULTS_ON_PAGE if there
370 # are no results in the response.
371 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
372 # value format. For example:
373 #
374 # &quot;data&quot;: [
375 # {
376 # &quot;key&quot;: &quot;scope&quot;,
377 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
378 # }
379 {
380 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
381 # returned. For example, for warnings where there are no results in a list
382 # request for a particular zone, this key might be scope and
383 # the key value might be the zone name. Other examples might be a key
384 # indicating a deprecated resource and a suggested replacement, or a
385 # warning about invalid network settings (for example, if an instance
386 # attempts to perform IP forwarding but is not enabled for IP forwarding).
387 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
388 },
389 ],
390 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
391 },
392 ],
393 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
394 # applicable when performing per-zone operations.
395 }</pre>
396 </div>
397
398 <div class="method">
399 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
400 <pre>Retrieves a list of Operation resources contained within
401 the specified region.
402
403 Args:
404 project: string, Project ID for this request. (required)
405 region: string, Name of the region for this request. (required)
406 filter: string, A filter expression that filters resources listed in the response. Most
407 Compute resources support two types of filter expressions:
408 expressions that support regular expressions and expressions that follow
409 API improvement proposal AIP-160.
410 These two types of filter expressions cannot be mixed in one request.
411
412 If you want to use AIP-160, your expression must specify the field name, an
413 operator, and the value that you want to use for filtering. The value
414 must be a string, a number, or a boolean. The operator
415 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
416
417 For example, if you are filtering Compute Engine instances, you can
418 exclude instances named `example-instance` by specifying
419 `name != example-instance`.
420
421 The `:*` comparison can be used to test whether a key has been defined.
422 For example, to find all objects with `owner` label use:
423 ```
424 labels.owner:*
425 ```
426
427 You can also filter nested fields. For example, you could specify
428 `scheduling.automaticRestart = false` to include instances only
429 if they are not scheduled for automatic restarts. You can use filtering
430 on nested fields to filter based onresource labels.
431
432 To filter on multiple expressions, provide each separate expression within
433 parentheses. For example:
434 ```
435 (scheduling.automaticRestart = true)
436 (cpuPlatform = &quot;Intel Skylake&quot;)
437 ```
438 By default, each expression is an `AND` expression. However, you
439 can include `AND` and `OR` expressions explicitly.
440 For example:
441 ```
442 (cpuPlatform = &quot;Intel Skylake&quot;) OR
443 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
444 (scheduling.automaticRestart = true)
445 ```
446
447 If you want to use a regular expression, use the `eq` (equal) or `ne`
448 (not equal) operator against a single un-parenthesized expression with or
449 without quotes or against multiple parenthesized expressions. Examples:
450
451 `fieldname eq unquoted literal`
452 `fieldname eq &#x27;single quoted literal&#x27;`
453 `fieldname eq &quot;double quoted literal&quot;`
454 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
455
456 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
457 The literal value must match the entire field.
458
459 For example, to filter for instances that do not end with name &quot;instance&quot;,
460 you would use `name ne .*instance`.
461
462 You cannot combine constraints on multiple fields using regular
463 expressions.
464 maxResults: integer, The maximum number of results per page that should be returned.
465 If the number of available results is larger than `maxResults`,
466 Compute Engine returns a `nextPageToken` that can be used to get
467 the next page of results in subsequent list requests. Acceptable values are
468 `0` to `500`, inclusive. (Default: `500`)
469 orderBy: string, Sorts list results by a certain order. By default, results
470 are returned in alphanumerical order based on the resource name.
471
472 You can also sort results in descending order based on the creation
473 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
474 results based on the `creationTimestamp` field in
475 reverse chronological order (newest result first). Use this to sort
476 resources like operations so that the newest operation is returned first.
477
478 Currently, only sorting by `name` or
479 `creationTimestamp desc` is supported.
480 pageToken: string, Specifies a page token to use. Set `pageToken` to the
481 `nextPageToken` returned by a previous list request to get
482 the next page of results.
483 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
484 of failure. The default value is false.
485
486 For example, when partial success behavior is enabled, aggregatedList for a
487 single zone scope either returns all resources in the zone or no resources,
488 with an error code.
489 x__xgafv: string, V1 error format.
490 Allowed values
491 1 - v1 error format
492 2 - v2 error format
493
494 Returns:
495 An object of the form:
496
497 { # Contains a list of Operation resources.
498 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
499 # defined by the server.
500 &quot;items&quot;: [ # [Output Only] A list of Operation resources.
501 { # Represents an Operation resource.
502 #
503 # Google Compute Engine has three Operation resources:
504 #
505 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
506 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
507 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
508 #
509 # You can use an operation resource to manage asynchronous API requests.
510 # For more information, readHandling
511 # API responses.
512 #
513 # Operations can be global, regional or zonal.
514 #
515 # - For global operations, use the `globalOperations`
516 # resource.
517 # - For regional operations, use the
518 # `regionOperations` resource.
519 # - For zonal operations, use
520 # the `zoneOperations` resource.
521 #
522 #
523 #
524 # For more information, read
525 # Global, Regional, and Zonal Resources.
526 #
527 # Note that completed Operation resources have a limited
528 # retention period.
529 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
530 # Not present otherwise.
531 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
532 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
533 # set when the operation is created.
534 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
535 # text format.
536 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
537 # this field will be populated.
538 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
539 # operation.
540 {
541 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
542 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
543 # details. There is a set of defined message types to use for providing
544 # details.The syntax depends on the error code. For example,
545 # QuotaExceededInfo will have details when the error code is
546 # QUOTA_EXCEEDED.
547 {
548 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
549 #
550 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
551 # is not enabled:
552 #
553 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
554 # &quot;domain&quot;: &quot;googleapis.com&quot;
555 # &quot;metadata&quot;: {
556 # &quot;resource&quot;: &quot;projects/123&quot;,
557 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
558 # }
559 # }
560 #
561 # This response indicates that the pubsub.googleapis.com API is not enabled.
562 #
563 # Example of an error that is returned when attempting to create a Spanner
564 # instance in a region that is out of stock:
565 #
566 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
567 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
568 # &quot;metadata&quot;: {
569 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
570 # }
571 # }
572 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
573 # is typically the registered service name of the tool or product that
574 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
575 # generated by some common infrastructure, the error domain must be a
576 # globally unique value that identifies the infrastructure. For Google API
577 # infrastructure, the error domain is &quot;googleapis.com&quot;.
578 &quot;metadatas&quot;: { # Additional structured details about this error.
579 #
580 # Keys must match a regular expression of `a-z+` but should
581 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
582 # length. When identifying the current value of an exceeded limit, the units
583 # should be contained in the key, not the value. For example, rather than
584 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
585 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
586 # instances that can be created in a single (batch) request.
587 &quot;a_key&quot;: &quot;A String&quot;,
588 },
589 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
590 # proximate cause of the error. Error reasons are unique within a particular
591 # domain of errors. This should be at most 63 characters and match a
592 # regular expression of `A-Z+[A-Z0-9]`, which represents
593 # UPPER_SNAKE_CASE.
594 },
595 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
596 #
597 # For example, if a quota check failed with an error indicating the calling
598 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
599 # directly to the right place in the developer console to flip the bit.
600 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
601 { # Describes a URL link.
602 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
603 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
604 },
605 ],
606 },
607 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
608 # which can be attached to an RPC error.
609 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
610 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
611 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
612 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
613 },
614 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
615 &quot;dimensions&quot;: { # The map holding related quota dimensions.
616 &quot;a_key&quot;: &quot;A String&quot;,
617 },
618 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
619 # type or metric.
620 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
621 # or metric.
622 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
623 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
624 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
625 },
626 },
627 ],
628 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
629 # This property is optional.
630 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
631 },
632 ],
633 },
634 &quot;getVersionOperationMetadata&quot;: {
635 &quot;inlineSbomInfo&quot;: {
636 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
637 # appropriate identifiers.
638 &quot;a_key&quot;: &quot;A String&quot;,
639 },
640 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
641 # identifiers.
642 &quot;a_key&quot;: &quot;A String&quot;,
643 },
644 },
645 },
646 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
647 # message that was returned, such as `NOT FOUND`.
648 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
649 # status code that was returned. For example, a `404` means the
650 # resource was not found.
651 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
652 # defined by the server.
653 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
654 # This value is inRFC3339
655 # text format.
656 &quot;instancesBulkInsertOperationMetadata&quot;: {
657 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
658 # Example key: zones/us-central1-a
659 &quot;a_key&quot;: {
660 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
661 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
662 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
663 # error.
664 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
665 # if the flow is rolling forward or rolling back.
666 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
667 },
668 },
669 },
670 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
671 # Operation resources.
672 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
673 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
674 # group of operations results from a `bulkInsert` API request.
675 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
676 # `update`, or `delete`, and so on.
677 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
678 # There is no requirement that this be linear or support any granularity of
679 # operations. This should not be used to guess when the operation will be
680 # complete. This number should monotonically increase as the operation
681 # progresses.
682 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
683 # applicable when performing regional operations.
684 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
685 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
686 # this field will contain information on all underlying zonal actions and
687 # their state.
688 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
689 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
690 # Example key: zones/us-central1-a
691 &quot;a_key&quot;: {
692 &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
693 # populated.
694 # different programming environments, including REST APIs and RPC APIs. It is
695 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
696 # three pieces of data: error code, error message, and error details.
697 #
698 # You can find out more about this error model and how to work with it in the
699 # [API Design Guide](https://cloud.google.com/apis/design/errors).
700 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
701 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
702 # message types for APIs to use.
703 {
704 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
705 },
706 ],
707 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
708 # user-facing error message should be localized and sent in the
709 # google.rpc.Status.details field, or localized by the client.
710 },
711 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
712 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
713 },
714 },
715 },
716 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
717 # This value is inRFC3339
718 # text format.
719 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
720 # following:
721 # `PENDING`, `RUNNING`, or `DONE`.
722 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
723 # operation.
724 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
725 # of the target resource.
726 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
727 # operations related to creating a snapshot, this points to the disk
728 # that the snapshot was created from.
729 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
730 # `[email protected]` or
731 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
732 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
733 # operation, this field will be populated.
734 {
735 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
736 # Engine returns NO_RESULTS_ON_PAGE if there
737 # are no results in the response.
738 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
739 # value format. For example:
740 #
741 # &quot;data&quot;: [
742 # {
743 # &quot;key&quot;: &quot;scope&quot;,
744 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
745 # }
746 {
747 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
748 # returned. For example, for warnings where there are no results in a list
749 # request for a particular zone, this key might be scope and
750 # the key value might be the zone name. Other examples might be a key
751 # indicating a deprecated resource and a suggested replacement, or a
752 # warning about invalid network settings (for example, if an instance
753 # attempts to perform IP forwarding but is not enabled for IP forwarding).
754 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
755 },
756 ],
757 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
758 },
759 ],
760 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
761 # applicable when performing per-zone operations.
762 },
763 ],
764 &quot;kind&quot;: &quot;compute#operationList&quot;, # Output only. [Output Only] Type of resource. Always `compute#operations` for Operations
765 # resource.
766 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
767 # list requests. If the number of results is larger than
768 # `maxResults`, use the `nextPageToken` as a value for
769 # the query parameter `pageToken` in the next list request.
770 # Subsequent list requests will have their own `nextPageToken` to
771 # continue paging through the results.
772 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
773 &quot;warning&quot;: { # [Output Only] Informational warning message.
774 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
775 # Engine returns NO_RESULTS_ON_PAGE if there
776 # are no results in the response.
777 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
778 # value format. For example:
779 #
780 # &quot;data&quot;: [
781 # {
782 # &quot;key&quot;: &quot;scope&quot;,
783 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
784 # }
785 {
786 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
787 # returned. For example, for warnings where there are no results in a list
788 # request for a particular zone, this key might be scope and
789 # the key value might be the zone name. Other examples might be a key
790 # indicating a deprecated resource and a suggested replacement, or a
791 # warning about invalid network settings (for example, if an instance
792 # attempts to perform IP forwarding but is not enabled for IP forwarding).
793 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
794 },
795 ],
796 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
797 },
798 }</pre>
799 </div>
800
801 <div class="method">
802 <code class="details" id="list_next">list_next()</code>
803 <pre>Retrieves the next page of results.
804
805 Args:
806 previous_request: The request for the previous page. (required)
807 previous_response: The response from the request for the previous page. (required)
808
809 Returns:
810 A request object that you can call &#x27;execute()&#x27; on to request the next
811 page. Returns None if there are no more items in the collection.
812 </pre>
813 </div>
814
815 <div class="method">
816 <code class="details" id="wait">wait(project, region, operation, x__xgafv=None)</code>
817 <pre>Waits for the specified Operation resource to return as `DONE`
818 or for the request to approach the 2 minute deadline, and retrieves the
819 specified Operation resource. This method differs from the
820 `GET` method in that it waits for no more than the default
821 deadline (2 minutes) and then returns the current state of the operation,
822 which might be `DONE` or still in progress.
823
824 This method is called on a best-effort basis. Specifically:
825
826
827 - In uncommon cases, when the server is overloaded, the request might
828 return before the default deadline is reached, or might return after zero
829 seconds.
830 - If the default deadline is reached, there is no guarantee that the
831 operation is actually done when the method returns. Be prepared to retry
832 if the operation is not `DONE`.
833
834 Args:
835 project: string, Project ID for this request. (required)
836 region: string, Name of the region for this request. (required)
837 operation: string, Name of the Operations resource to return, or its unique numeric
838 identifier. (required)
839 x__xgafv: string, V1 error format.
840 Allowed values
841 1 - v1 error format
842 2 - v2 error format
843
844 Returns:
845 An object of the form:
846
847 { # Represents an Operation resource.
848 #
849 # Google Compute Engine has three Operation resources:
850 #
851 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
852 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
853 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
854 #
855 # You can use an operation resource to manage asynchronous API requests.
856 # For more information, readHandling
857 # API responses.
858 #
859 # Operations can be global, regional or zonal.
860 #
861 # - For global operations, use the `globalOperations`
862 # resource.
863 # - For regional operations, use the
864 # `regionOperations` resource.
865 # - For zonal operations, use
866 # the `zoneOperations` resource.
867 #
868 #
869 #
870 # For more information, read
871 # Global, Regional, and Zonal Resources.
872 #
873 # Note that completed Operation resources have a limited
874 # retention period.
875 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
876 # Not present otherwise.
877 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
878 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
879 # set when the operation is created.
880 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
881 # text format.
882 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
883 # this field will be populated.
884 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
885 # operation.
886 {
887 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
888 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
889 # details. There is a set of defined message types to use for providing
890 # details.The syntax depends on the error code. For example,
891 # QuotaExceededInfo will have details when the error code is
892 # QUOTA_EXCEEDED.
893 {
894 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
895 #
896 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
897 # is not enabled:
898 #
899 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
900 # &quot;domain&quot;: &quot;googleapis.com&quot;
901 # &quot;metadata&quot;: {
902 # &quot;resource&quot;: &quot;projects/123&quot;,
903 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
904 # }
905 # }
906 #
907 # This response indicates that the pubsub.googleapis.com API is not enabled.
908 #
909 # Example of an error that is returned when attempting to create a Spanner
910 # instance in a region that is out of stock:
911 #
912 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
913 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
914 # &quot;metadata&quot;: {
915 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
916 # }
917 # }
918 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
919 # is typically the registered service name of the tool or product that
920 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
921 # generated by some common infrastructure, the error domain must be a
922 # globally unique value that identifies the infrastructure. For Google API
923 # infrastructure, the error domain is &quot;googleapis.com&quot;.
924 &quot;metadatas&quot;: { # Additional structured details about this error.
925 #
926 # Keys must match a regular expression of `a-z+` but should
927 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
928 # length. When identifying the current value of an exceeded limit, the units
929 # should be contained in the key, not the value. For example, rather than
930 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
931 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
932 # instances that can be created in a single (batch) request.
933 &quot;a_key&quot;: &quot;A String&quot;,
934 },
935 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
936 # proximate cause of the error. Error reasons are unique within a particular
937 # domain of errors. This should be at most 63 characters and match a
938 # regular expression of `A-Z+[A-Z0-9]`, which represents
939 # UPPER_SNAKE_CASE.
940 },
941 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
942 #
943 # For example, if a quota check failed with an error indicating the calling
944 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
945 # directly to the right place in the developer console to flip the bit.
946 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
947 { # Describes a URL link.
948 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
949 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
950 },
951 ],
952 },
953 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
954 # which can be attached to an RPC error.
955 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
956 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
957 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
958 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
959 },
960 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
961 &quot;dimensions&quot;: { # The map holding related quota dimensions.
962 &quot;a_key&quot;: &quot;A String&quot;,
963 },
964 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
965 # type or metric.
966 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
967 # or metric.
968 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
969 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
970 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
971 },
972 },
973 ],
974 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
975 # This property is optional.
976 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
977 },
978 ],
979 },
980 &quot;getVersionOperationMetadata&quot;: {
981 &quot;inlineSbomInfo&quot;: {
982 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
983 # appropriate identifiers.
984 &quot;a_key&quot;: &quot;A String&quot;,
985 },
986 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
987 # identifiers.
988 &quot;a_key&quot;: &quot;A String&quot;,
989 },
990 },
991 },
992 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
993 # message that was returned, such as `NOT FOUND`.
994 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
995 # status code that was returned. For example, a `404` means the
996 # resource was not found.
997 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
998 # defined by the server.
999 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1000 # This value is inRFC3339
1001 # text format.
1002 &quot;instancesBulkInsertOperationMetadata&quot;: {
1003 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1004 # Example key: zones/us-central1-a
1005 &quot;a_key&quot;: {
1006 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1007 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1008 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1009 # error.
1010 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1011 # if the flow is rolling forward or rolling back.
1012 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1013 },
1014 },
1015 },
1016 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1017 # Operation resources.
1018 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1019 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1020 # group of operations results from a `bulkInsert` API request.
1021 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1022 # `update`, or `delete`, and so on.
1023 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1024 # There is no requirement that this be linear or support any granularity of
1025 # operations. This should not be used to guess when the operation will be
1026 # complete. This number should monotonically increase as the operation
1027 # progresses.
1028 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1029 # applicable when performing regional operations.
1030 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1031 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1032 # this field will contain information on all underlying zonal actions and
1033 # their state.
1034 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1035 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1036 # Example key: zones/us-central1-a
1037 &quot;a_key&quot;: {
1038 &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
1039 # populated.
1040 # different programming environments, including REST APIs and RPC APIs. It is
1041 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1042 # three pieces of data: error code, error message, and error details.
1043 #
1044 # You can find out more about this error model and how to work with it in the
1045 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1046 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1047 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1048 # message types for APIs to use.
1049 {
1050 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1051 },
1052 ],
1053 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1054 # user-facing error message should be localized and sent in the
1055 # google.rpc.Status.details field, or localized by the client.
1056 },
1057 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1058 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1059 },
1060 },
1061 },
1062 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1063 # This value is inRFC3339
1064 # text format.
1065 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1066 # following:
1067 # `PENDING`, `RUNNING`, or `DONE`.
1068 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1069 # operation.
1070 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1071 # of the target resource.
1072 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1073 # operations related to creating a snapshot, this points to the disk
1074 # that the snapshot was created from.
1075 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1076 # `[email protected]` or
1077 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1078 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1079 # operation, this field will be populated.
1080 {
1081 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1082 # Engine returns NO_RESULTS_ON_PAGE if there
1083 # are no results in the response.
1084 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1085 # value format. For example:
1086 #
1087 # &quot;data&quot;: [
1088 # {
1089 # &quot;key&quot;: &quot;scope&quot;,
1090 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1091 # }
1092 {
1093 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1094 # returned. For example, for warnings where there are no results in a list
1095 # request for a particular zone, this key might be scope and
1096 # the key value might be the zone name. Other examples might be a key
1097 # indicating a deprecated resource and a suggested replacement, or a
1098 # warning about invalid network settings (for example, if an instance
1099 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1100 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1101 },
1102 ],
1103 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1104 },
1105 ],
1106 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1107 # applicable when performing per-zone operations.
1108 }</pre>
1109 </div>
1110
1111 </body></html>