Debian Codegraph @

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