Debian Codegraph @

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