Debian Codegraph @

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