Debian Codegraph @

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