Debian Codegraph @

docs/dyn/compute_alpha.globalFolderOperations.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.globalFolderOperations.html">globalFolderOperations</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(folder, operation, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves the specified Operations resource.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of Operation resources contained within the specified</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(folder, operation, x__xgafv=None)</code>
97 <pre>Retrieves the specified Operations resource.
98
99 Args:
100 folder: string, Folder ID for this request. (required)
101 operation: string, Name of the Operations resource to return. (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Represents an Operation resource.
111 #
112 # Google Compute Engine has three Operation resources:
113 #
114 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
115 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
116 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
117 #
118 # You can use an operation resource to manage asynchronous API requests.
119 # For more information, readHandling
120 # API responses.
121 #
122 # Operations can be global, regional or zonal.
123 #
124 # - For global operations, use the `globalOperations`
125 # resource.
126 # - For regional operations, use the
127 # `regionOperations` resource.
128 # - For zonal operations, use
129 # the `zoneOperations` resource.
130 #
131 #
132 #
133 # For more information, read
134 # Global, Regional, and Zonal Resources.
135 #
136 # Note that completed Operation resources have a limited
137 # retention period.
138 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
139 # Not present otherwise.
140 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
141 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
142 # set when the operation is created.
143 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
144 # text format.
145 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
146 # this field will be populated.
147 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
148 # operation.
149 {
150 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
151 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
152 # details. There is a set of defined message types to use for providing
153 # details.The syntax depends on the error code. For example,
154 # QuotaExceededInfo will have details when the error code is
155 # QUOTA_EXCEEDED.
156 {
157 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
158 #
159 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
160 # is not enabled:
161 #
162 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
163 # &quot;domain&quot;: &quot;googleapis.com&quot;
164 # &quot;metadata&quot;: {
165 # &quot;resource&quot;: &quot;projects/123&quot;,
166 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
167 # }
168 # }
169 #
170 # This response indicates that the pubsub.googleapis.com API is not enabled.
171 #
172 # Example of an error that is returned when attempting to create a Spanner
173 # instance in a region that is out of stock:
174 #
175 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
176 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
177 # &quot;metadata&quot;: {
178 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
179 # }
180 # }
181 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
182 # is typically the registered service name of the tool or product that
183 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
184 # generated by some common infrastructure, the error domain must be a
185 # globally unique value that identifies the infrastructure. For Google API
186 # infrastructure, the error domain is &quot;googleapis.com&quot;.
187 &quot;metadatas&quot;: { # Additional structured details about this error.
188 #
189 # Keys must match a regular expression of `a-z+` but should
190 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
191 # length. When identifying the current value of an exceeded limit, the units
192 # should be contained in the key, not the value. For example, rather than
193 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
194 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
195 # instances that can be created in a single (batch) request.
196 &quot;a_key&quot;: &quot;A String&quot;,
197 },
198 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
199 # proximate cause of the error. Error reasons are unique within a particular
200 # domain of errors. This should be at most 63 characters and match a
201 # regular expression of `A-Z+[A-Z0-9]`, which represents
202 # UPPER_SNAKE_CASE.
203 },
204 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
205 #
206 # For example, if a quota check failed with an error indicating the calling
207 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
208 # directly to the right place in the developer console to flip the bit.
209 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
210 { # Describes a URL link.
211 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
212 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
213 },
214 ],
215 },
216 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
217 # which can be attached to an RPC error.
218 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
219 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
220 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
221 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
222 },
223 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
224 &quot;dimensions&quot;: { # The map holding related quota dimensions.
225 &quot;a_key&quot;: &quot;A String&quot;,
226 },
227 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
228 # type or metric.
229 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
230 # or metric.
231 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
232 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
233 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
234 },
235 },
236 ],
237 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
238 # This property is optional.
239 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
240 },
241 ],
242 },
243 &quot;getVersionOperationMetadata&quot;: {
244 &quot;inlineSbomInfo&quot;: {
245 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
246 # appropriate identifiers.
247 &quot;a_key&quot;: &quot;A String&quot;,
248 },
249 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
250 # identifiers.
251 &quot;a_key&quot;: &quot;A String&quot;,
252 },
253 },
254 },
255 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
256 # message that was returned, such as `NOT FOUND`.
257 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
258 # status code that was returned. For example, a `404` means the
259 # resource was not found.
260 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
261 # defined by the server.
262 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
263 # This value is inRFC3339
264 # text format.
265 &quot;instancesBulkInsertOperationMetadata&quot;: {
266 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
267 # Example key: zones/us-central1-a
268 &quot;a_key&quot;: {
269 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
270 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
271 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
272 # error.
273 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
274 # if the flow is rolling forward or rolling back.
275 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
276 },
277 },
278 },
279 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
280 # Operation resources.
281 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
282 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
283 # group of operations results from a `bulkInsert` API request.
284 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
285 # `update`, or `delete`, and so on.
286 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
287 # There is no requirement that this be linear or support any granularity of
288 # operations. This should not be used to guess when the operation will be
289 # complete. This number should monotonically increase as the operation
290 # progresses.
291 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
292 # applicable when performing regional operations.
293 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
294 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
295 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
296 # this field will contain information on all underlying zonal actions and
297 # their state.
298 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
299 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
300 # Example key: zones/us-central1-a
301 &quot;a_key&quot;: {
302 &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
303 # populated.
304 # different programming environments, including REST APIs and RPC APIs. It is
305 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
306 # three pieces of data: error code, error message, and error details.
307 #
308 # You can find out more about this error model and how to work with it in the
309 # [API Design Guide](https://cloud.google.com/apis/design/errors).
310 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
311 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
312 # message types for APIs to use.
313 {
314 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
315 },
316 ],
317 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
318 # user-facing error message should be localized and sent in the
319 # google.rpc.Status.details field, or localized by the client.
320 },
321 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
322 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
323 },
324 },
325 },
326 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
327 # This value is inRFC3339
328 # text format.
329 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
330 # following:
331 # `PENDING`, `RUNNING`, or `DONE`.
332 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
333 # operation.
334 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
335 # of the target resource.
336 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
337 # operations related to creating a snapshot, this points to the disk
338 # that the snapshot was created from.
339 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
340 # `[email protected]` or
341 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
342 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
343 # operation, this field will be populated.
344 {
345 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
346 # Engine returns NO_RESULTS_ON_PAGE if there
347 # are no results in the response.
348 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
349 # value format. For example:
350 #
351 # &quot;data&quot;: [
352 # {
353 # &quot;key&quot;: &quot;scope&quot;,
354 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
355 # }
356 {
357 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
358 # returned. For example, for warnings where there are no results in a list
359 # request for a particular zone, this key might be scope and
360 # the key value might be the zone name. Other examples might be a key
361 # indicating a deprecated resource and a suggested replacement, or a
362 # warning about invalid network settings (for example, if an instance
363 # attempts to perform IP forwarding but is not enabled for IP forwarding).
364 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
365 },
366 ],
367 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
368 },
369 ],
370 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
371 # applicable when performing per-zone operations.
372 }</pre>
373 </div>
374
375 <div class="method">
376 <code class="details" id="list">list(folder, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
377 <pre>Retrieves a list of Operation resources contained within the specified
378 folder.
379
380 Args:
381 folder: string, Folder ID for this request. (required)
382 filter: string, A filter expression that filters resources listed in the response. Most
383 Compute resources support two types of filter expressions:
384 expressions that support regular expressions and expressions that follow
385 API improvement proposal AIP-160.
386 These two types of filter expressions cannot be mixed in one request.
387
388 If you want to use AIP-160, your expression must specify the field name, an
389 operator, and the value that you want to use for filtering. The value
390 must be a string, a number, or a boolean. The operator
391 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
392
393 For example, if you are filtering Compute Engine instances, you can
394 exclude instances named `example-instance` by specifying
395 `name != example-instance`.
396
397 The `:*` comparison can be used to test whether a key has been defined.
398 For example, to find all objects with `owner` label use:
399 ```
400 labels.owner:*
401 ```
402
403 You can also filter nested fields. For example, you could specify
404 `scheduling.automaticRestart = false` to include instances only
405 if they are not scheduled for automatic restarts. You can use filtering
406 on nested fields to filter based onresource labels.
407
408 To filter on multiple expressions, provide each separate expression within
409 parentheses. For example:
410 ```
411 (scheduling.automaticRestart = true)
412 (cpuPlatform = &quot;Intel Skylake&quot;)
413 ```
414 By default, each expression is an `AND` expression. However, you
415 can include `AND` and `OR` expressions explicitly.
416 For example:
417 ```
418 (cpuPlatform = &quot;Intel Skylake&quot;) OR
419 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
420 (scheduling.automaticRestart = true)
421 ```
422
423 If you want to use a regular expression, use the `eq` (equal) or `ne`
424 (not equal) operator against a single un-parenthesized expression with or
425 without quotes or against multiple parenthesized expressions. Examples:
426
427 `fieldname eq unquoted literal`
428 `fieldname eq &#x27;single quoted literal&#x27;`
429 `fieldname eq &quot;double quoted literal&quot;`
430 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
431
432 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
433 The literal value must match the entire field.
434
435 For example, to filter for instances that do not end with name &quot;instance&quot;,
436 you would use `name ne .*instance`.
437
438 You cannot combine constraints on multiple fields using regular
439 expressions.
440 maxResults: integer, The maximum number of results per page that should be returned.
441 If the number of available results is larger than `maxResults`,
442 Compute Engine returns a `nextPageToken` that can be used to get
443 the next page of results in subsequent list requests. Acceptable values are
444 `0` to `500`, inclusive. (Default: `500`)
445 orderBy: string, Sorts list results by a certain order. By default, results
446 are returned in alphanumerical order based on the resource name.
447
448 You can also sort results in descending order based on the creation
449 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
450 results based on the `creationTimestamp` field in
451 reverse chronological order (newest result first). Use this to sort
452 resources like operations so that the newest operation is returned first.
453
454 Currently, only sorting by `name` or
455 `creationTimestamp desc` is supported.
456 pageToken: string, Specifies a page token to use. Set `pageToken` to the
457 `nextPageToken` returned by a previous list request to get
458 the next page of results.
459 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
460 of failure. The default value is false.
461
462 For example, when partial success behavior is enabled, aggregatedList for a
463 single zone scope either returns all resources in the zone or no resources,
464 with an error code.
465 x__xgafv: string, V1 error format.
466 Allowed values
467 1 - v1 error format
468 2 - v2 error format
469
470 Returns:
471 An object of the form:
472
473 { # Contains a list of Operation resources.
474 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is
475 # defined by the server.
476 &quot;items&quot;: [ # [Output Only] A list of Operation resources.
477 { # Represents an Operation resource.
478 #
479 # Google Compute Engine has three Operation resources:
480 #
481 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
482 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
483 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
484 #
485 # You can use an operation resource to manage asynchronous API requests.
486 # For more information, readHandling
487 # API responses.
488 #
489 # Operations can be global, regional or zonal.
490 #
491 # - For global operations, use the `globalOperations`
492 # resource.
493 # - For regional operations, use the
494 # `regionOperations` resource.
495 # - For zonal operations, use
496 # the `zoneOperations` resource.
497 #
498 #
499 #
500 # For more information, read
501 # Global, Regional, and Zonal Resources.
502 #
503 # Note that completed Operation resources have a limited
504 # retention period.
505 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
506 # Not present otherwise.
507 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
508 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
509 # set when the operation is created.
510 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
511 # text format.
512 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
513 # this field will be populated.
514 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
515 # operation.
516 {
517 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
518 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
519 # details. There is a set of defined message types to use for providing
520 # details.The syntax depends on the error code. For example,
521 # QuotaExceededInfo will have details when the error code is
522 # QUOTA_EXCEEDED.
523 {
524 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
525 #
526 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
527 # is not enabled:
528 #
529 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
530 # &quot;domain&quot;: &quot;googleapis.com&quot;
531 # &quot;metadata&quot;: {
532 # &quot;resource&quot;: &quot;projects/123&quot;,
533 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
534 # }
535 # }
536 #
537 # This response indicates that the pubsub.googleapis.com API is not enabled.
538 #
539 # Example of an error that is returned when attempting to create a Spanner
540 # instance in a region that is out of stock:
541 #
542 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
543 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
544 # &quot;metadata&quot;: {
545 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
546 # }
547 # }
548 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
549 # is typically the registered service name of the tool or product that
550 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
551 # generated by some common infrastructure, the error domain must be a
552 # globally unique value that identifies the infrastructure. For Google API
553 # infrastructure, the error domain is &quot;googleapis.com&quot;.
554 &quot;metadatas&quot;: { # Additional structured details about this error.
555 #
556 # Keys must match a regular expression of `a-z+` but should
557 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
558 # length. When identifying the current value of an exceeded limit, the units
559 # should be contained in the key, not the value. For example, rather than
560 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
561 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
562 # instances that can be created in a single (batch) request.
563 &quot;a_key&quot;: &quot;A String&quot;,
564 },
565 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
566 # proximate cause of the error. Error reasons are unique within a particular
567 # domain of errors. This should be at most 63 characters and match a
568 # regular expression of `A-Z+[A-Z0-9]`, which represents
569 # UPPER_SNAKE_CASE.
570 },
571 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
572 #
573 # For example, if a quota check failed with an error indicating the calling
574 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
575 # directly to the right place in the developer console to flip the bit.
576 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
577 { # Describes a URL link.
578 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
579 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
580 },
581 ],
582 },
583 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
584 # which can be attached to an RPC error.
585 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
586 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
587 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
588 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
589 },
590 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
591 &quot;dimensions&quot;: { # The map holding related quota dimensions.
592 &quot;a_key&quot;: &quot;A String&quot;,
593 },
594 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
595 # type or metric.
596 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
597 # or metric.
598 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
599 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
600 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
601 },
602 },
603 ],
604 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
605 # This property is optional.
606 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
607 },
608 ],
609 },
610 &quot;getVersionOperationMetadata&quot;: {
611 &quot;inlineSbomInfo&quot;: {
612 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
613 # appropriate identifiers.
614 &quot;a_key&quot;: &quot;A String&quot;,
615 },
616 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
617 # identifiers.
618 &quot;a_key&quot;: &quot;A String&quot;,
619 },
620 },
621 },
622 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
623 # message that was returned, such as `NOT FOUND`.
624 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
625 # status code that was returned. For example, a `404` means the
626 # resource was not found.
627 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
628 # defined by the server.
629 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
630 # This value is inRFC3339
631 # text format.
632 &quot;instancesBulkInsertOperationMetadata&quot;: {
633 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
634 # Example key: zones/us-central1-a
635 &quot;a_key&quot;: {
636 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
637 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
638 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
639 # error.
640 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
641 # if the flow is rolling forward or rolling back.
642 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
643 },
644 },
645 },
646 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
647 # Operation resources.
648 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
649 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
650 # group of operations results from a `bulkInsert` API request.
651 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
652 # `update`, or `delete`, and so on.
653 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
654 # There is no requirement that this be linear or support any granularity of
655 # operations. This should not be used to guess when the operation will be
656 # complete. This number should monotonically increase as the operation
657 # progresses.
658 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
659 # applicable when performing regional operations.
660 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
661 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
662 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
663 # this field will contain information on all underlying zonal actions and
664 # their state.
665 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
666 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
667 # Example key: zones/us-central1-a
668 &quot;a_key&quot;: {
669 &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
670 # populated.
671 # different programming environments, including REST APIs and RPC APIs. It is
672 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
673 # three pieces of data: error code, error message, and error details.
674 #
675 # You can find out more about this error model and how to work with it in the
676 # [API Design Guide](https://cloud.google.com/apis/design/errors).
677 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
678 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
679 # message types for APIs to use.
680 {
681 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
682 },
683 ],
684 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
685 # user-facing error message should be localized and sent in the
686 # google.rpc.Status.details field, or localized by the client.
687 },
688 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
689 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
690 },
691 },
692 },
693 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
694 # This value is inRFC3339
695 # text format.
696 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
697 # following:
698 # `PENDING`, `RUNNING`, or `DONE`.
699 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
700 # operation.
701 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
702 # of the target resource.
703 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
704 # operations related to creating a snapshot, this points to the disk
705 # that the snapshot was created from.
706 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
707 # `[email protected]` or
708 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
709 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
710 # operation, this field will be populated.
711 {
712 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
713 # Engine returns NO_RESULTS_ON_PAGE if there
714 # are no results in the response.
715 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
716 # value format. For example:
717 #
718 # &quot;data&quot;: [
719 # {
720 # &quot;key&quot;: &quot;scope&quot;,
721 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
722 # }
723 {
724 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
725 # returned. For example, for warnings where there are no results in a list
726 # request for a particular zone, this key might be scope and
727 # the key value might be the zone name. Other examples might be a key
728 # indicating a deprecated resource and a suggested replacement, or a
729 # warning about invalid network settings (for example, if an instance
730 # attempts to perform IP forwarding but is not enabled for IP forwarding).
731 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
732 },
733 ],
734 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
735 },
736 ],
737 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
738 # applicable when performing per-zone operations.
739 },
740 ],
741 &quot;kind&quot;: &quot;compute#operationList&quot;, # Output only. [Output Only] Type of resource. Always `compute#operations` for Operations
742 # resource.
743 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
744 # list requests. If the number of results is larger than
745 # `maxResults`, use the `nextPageToken` as a value for
746 # the query parameter `pageToken` in the next list request.
747 # Subsequent list requests will have their own `nextPageToken` to
748 # continue paging through the results.
749 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
750 &quot;warning&quot;: { # [Output Only] Informational warning message.
751 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
752 # Engine returns NO_RESULTS_ON_PAGE if there
753 # are no results in the response.
754 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
755 # value format. For example:
756 #
757 # &quot;data&quot;: [
758 # {
759 # &quot;key&quot;: &quot;scope&quot;,
760 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
761 # }
762 {
763 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
764 # returned. For example, for warnings where there are no results in a list
765 # request for a particular zone, this key might be scope and
766 # the key value might be the zone name. Other examples might be a key
767 # indicating a deprecated resource and a suggested replacement, or a
768 # warning about invalid network settings (for example, if an instance
769 # attempts to perform IP forwarding but is not enabled for IP forwarding).
770 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
771 },
772 ],
773 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
774 },
775 }</pre>
776 </div>
777
778 <div class="method">
779 <code class="details" id="list_next">list_next()</code>
780 <pre>Retrieves the next page of results.
781
782 Args:
783 previous_request: The request for the previous page. (required)
784 previous_response: The response from the request for the previous page. (required)
785
786 Returns:
787 A request object that you can call &#x27;execute()&#x27; on to request the next
788 page. Returns None if there are no more items in the collection.
789 </pre>
790 </div>
791
792 </body></html>