Debian Codegraph @

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