Debian Codegraph @

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