Debian Codegraph @

docs/dyn/compute_alpha.rollouts.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.rollouts.html">rollouts</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#advance">advance(project, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Advances a Rollout to the next wave, or completes it if no waves remain.</p>
80 <p class="toc_element">
81 <code><a href="#cancel">cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Cancels a Rollout.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, rollout, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes a Rollout.</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, rollout, x__xgafv=None)</a></code></p>
91 <p class="firstline">Gets details of a single project-scoped Rollout.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Lists Rollouts in a given project and location.</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <p class="toc_element">
99 <code><a href="#pause">pause(project, rollout, etag=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Pauses a Rollout.</p>
101 <p class="toc_element">
102 <code><a href="#resume">resume(project, rollout, etag=None, requestId=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Resumes a Rollout.</p>
104 <h3>Method Details</h3>
105 <div class="method">
106 <code class="details" id="advance">advance(project, rollout, currentWaveNumber=None, requestId=None, x__xgafv=None)</code>
107 <pre>Advances a Rollout to the next wave, or completes it if no waves remain.
108
109 Args:
110 project: string, Required. Project ID for this request. (required)
111 rollout: string, Required. Name of the Rollout resource to advance. (required)
112 currentWaveNumber: string, Required. Wave number of the current wave.
113 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
114 that if you must retry your request, the server will know to ignore the
115 request if it has already been completed.
116
117 For example, consider a situation where you make an initial request and
118 the request times out. If you make the request again with the same
119 request ID, the server can check if original operation with the same
120 request ID was received, and if so, will ignore the second request. This
121 prevents clients from accidentally creating duplicate commitments.
122
123 The request ID must be
124 a valid UUID with the exception that zero UUID is not supported
125 (00000000-0000-0000-0000-000000000000).
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # Represents an Operation resource.
135 #
136 # Google Compute Engine has three Operation resources:
137 #
138 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
139 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
140 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
141 #
142 # You can use an operation resource to manage asynchronous API requests.
143 # For more information, readHandling
144 # API responses.
145 #
146 # Operations can be global, regional or zonal.
147 #
148 # - For global operations, use the `globalOperations`
149 # resource.
150 # - For regional operations, use the
151 # `regionOperations` resource.
152 # - For zonal operations, use
153 # the `zoneOperations` resource.
154 #
155 #
156 #
157 # For more information, read
158 # Global, Regional, and Zonal Resources.
159 #
160 # Note that completed Operation resources have a limited
161 # retention period.
162 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
163 # Not present otherwise.
164 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
165 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
166 # set when the operation is created.
167 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
168 # text format.
169 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
170 # this field will be populated.
171 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
172 # operation.
173 {
174 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
175 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
176 # details. There is a set of defined message types to use for providing
177 # details.The syntax depends on the error code. For example,
178 # QuotaExceededInfo will have details when the error code is
179 # QUOTA_EXCEEDED.
180 {
181 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
182 #
183 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
184 # is not enabled:
185 #
186 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
187 # &quot;domain&quot;: &quot;googleapis.com&quot;
188 # &quot;metadata&quot;: {
189 # &quot;resource&quot;: &quot;projects/123&quot;,
190 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
191 # }
192 # }
193 #
194 # This response indicates that the pubsub.googleapis.com API is not enabled.
195 #
196 # Example of an error that is returned when attempting to create a Spanner
197 # instance in a region that is out of stock:
198 #
199 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
200 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
201 # &quot;metadata&quot;: {
202 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
203 # }
204 # }
205 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
206 # is typically the registered service name of the tool or product that
207 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
208 # generated by some common infrastructure, the error domain must be a
209 # globally unique value that identifies the infrastructure. For Google API
210 # infrastructure, the error domain is &quot;googleapis.com&quot;.
211 &quot;metadatas&quot;: { # Additional structured details about this error.
212 #
213 # Keys must match a regular expression of `a-z+` but should
214 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
215 # length. When identifying the current value of an exceeded limit, the units
216 # should be contained in the key, not the value. For example, rather than
217 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
218 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
219 # instances that can be created in a single (batch) request.
220 &quot;a_key&quot;: &quot;A String&quot;,
221 },
222 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
223 # proximate cause of the error. Error reasons are unique within a particular
224 # domain of errors. This should be at most 63 characters and match a
225 # regular expression of `A-Z+[A-Z0-9]`, which represents
226 # UPPER_SNAKE_CASE.
227 },
228 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
229 #
230 # For example, if a quota check failed with an error indicating the calling
231 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
232 # directly to the right place in the developer console to flip the bit.
233 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
234 { # Describes a URL link.
235 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
236 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
237 },
238 ],
239 },
240 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
241 # which can be attached to an RPC error.
242 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
243 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
244 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
245 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
246 },
247 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
248 &quot;dimensions&quot;: { # The map holding related quota dimensions.
249 &quot;a_key&quot;: &quot;A String&quot;,
250 },
251 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
252 # type or metric.
253 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
254 # or metric.
255 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
256 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
257 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
258 },
259 },
260 ],
261 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
262 # This property is optional.
263 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
264 },
265 ],
266 },
267 &quot;getVersionOperationMetadata&quot;: {
268 &quot;inlineSbomInfo&quot;: {
269 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
270 # appropriate identifiers.
271 &quot;a_key&quot;: &quot;A String&quot;,
272 },
273 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
274 # identifiers.
275 &quot;a_key&quot;: &quot;A String&quot;,
276 },
277 },
278 },
279 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
280 # message that was returned, such as `NOT FOUND`.
281 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
282 # status code that was returned. For example, a `404` means the
283 # resource was not found.
284 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
285 # defined by the server.
286 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
287 # This value is inRFC3339
288 # text format.
289 &quot;instancesBulkInsertOperationMetadata&quot;: {
290 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
291 # Example key: zones/us-central1-a
292 &quot;a_key&quot;: {
293 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
294 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
295 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
296 # error.
297 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
298 # if the flow is rolling forward or rolling back.
299 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
300 },
301 },
302 },
303 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
304 # Operation resources.
305 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
306 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
307 # group of operations results from a `bulkInsert` API request.
308 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
309 # `update`, or `delete`, and so on.
310 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
311 # There is no requirement that this be linear or support any granularity of
312 # operations. This should not be used to guess when the operation will be
313 # complete. This number should monotonically increase as the operation
314 # progresses.
315 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
316 # applicable when performing regional operations.
317 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
318 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
319 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
320 # this field will contain information on all underlying zonal actions and
321 # their state.
322 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
323 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
324 # Example key: zones/us-central1-a
325 &quot;a_key&quot;: {
326 &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
327 # populated.
328 # different programming environments, including REST APIs and RPC APIs. It is
329 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
330 # three pieces of data: error code, error message, and error details.
331 #
332 # You can find out more about this error model and how to work with it in the
333 # [API Design Guide](https://cloud.google.com/apis/design/errors).
334 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
335 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
336 # message types for APIs to use.
337 {
338 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
339 },
340 ],
341 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
342 # user-facing error message should be localized and sent in the
343 # google.rpc.Status.details field, or localized by the client.
344 },
345 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
346 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
347 },
348 },
349 },
350 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
351 # This value is inRFC3339
352 # text format.
353 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
354 # following:
355 # `PENDING`, `RUNNING`, or `DONE`.
356 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
357 # operation.
358 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
359 # of the target resource.
360 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
361 # operations related to creating a snapshot, this points to the disk
362 # that the snapshot was created from.
363 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
364 # `[email protected]` or
365 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
366 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
367 # operation, this field will be populated.
368 {
369 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
370 # Engine returns NO_RESULTS_ON_PAGE if there
371 # are no results in the response.
372 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
373 # value format. For example:
374 #
375 # &quot;data&quot;: [
376 # {
377 # &quot;key&quot;: &quot;scope&quot;,
378 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
379 # }
380 {
381 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
382 # returned. For example, for warnings where there are no results in a list
383 # request for a particular zone, this key might be scope and
384 # the key value might be the zone name. Other examples might be a key
385 # indicating a deprecated resource and a suggested replacement, or a
386 # warning about invalid network settings (for example, if an instance
387 # attempts to perform IP forwarding but is not enabled for IP forwarding).
388 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
389 },
390 ],
391 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
392 },
393 ],
394 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
395 # applicable when performing per-zone operations.
396 }</pre>
397 </div>
398
399 <div class="method">
400 <code class="details" id="cancel">cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)</code>
401 <pre>Cancels a Rollout.
402
403 Args:
404 project: string, Project ID for this request. (required)
405 rollout: string, Name of the Rollout resource to cancel. (required)
406 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
407 that if you must retry your request, the server will know to ignore the
408 request if it has already been completed.
409
410 For example, consider a situation where you make an initial request and
411 the request times out. If you make the request again with the same
412 request ID, the server can check if original operation with the same
413 request ID was received, and if so, will ignore the second request. This
414 prevents clients from accidentally creating duplicate commitments.
415
416 The request ID must be
417 a valid UUID with the exception that zero UUID is not supported
418 (00000000-0000-0000-0000-000000000000).
419 rollback: boolean, Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel
420 the rollout without taking any further actions. Note that products must
421 support at least one of these options, however, it does not need to support
422 both.
423 x__xgafv: string, V1 error format.
424 Allowed values
425 1 - v1 error format
426 2 - v2 error format
427
428 Returns:
429 An object of the form:
430
431 { # Represents an Operation resource.
432 #
433 # Google Compute Engine has three Operation resources:
434 #
435 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
436 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
437 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
438 #
439 # You can use an operation resource to manage asynchronous API requests.
440 # For more information, readHandling
441 # API responses.
442 #
443 # Operations can be global, regional or zonal.
444 #
445 # - For global operations, use the `globalOperations`
446 # resource.
447 # - For regional operations, use the
448 # `regionOperations` resource.
449 # - For zonal operations, use
450 # the `zoneOperations` resource.
451 #
452 #
453 #
454 # For more information, read
455 # Global, Regional, and Zonal Resources.
456 #
457 # Note that completed Operation resources have a limited
458 # retention period.
459 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
460 # Not present otherwise.
461 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
462 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
463 # set when the operation is created.
464 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
465 # text format.
466 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
467 # this field will be populated.
468 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
469 # operation.
470 {
471 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
472 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
473 # details. There is a set of defined message types to use for providing
474 # details.The syntax depends on the error code. For example,
475 # QuotaExceededInfo will have details when the error code is
476 # QUOTA_EXCEEDED.
477 {
478 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
479 #
480 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
481 # is not enabled:
482 #
483 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
484 # &quot;domain&quot;: &quot;googleapis.com&quot;
485 # &quot;metadata&quot;: {
486 # &quot;resource&quot;: &quot;projects/123&quot;,
487 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
488 # }
489 # }
490 #
491 # This response indicates that the pubsub.googleapis.com API is not enabled.
492 #
493 # Example of an error that is returned when attempting to create a Spanner
494 # instance in a region that is out of stock:
495 #
496 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
497 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
498 # &quot;metadata&quot;: {
499 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
500 # }
501 # }
502 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
503 # is typically the registered service name of the tool or product that
504 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
505 # generated by some common infrastructure, the error domain must be a
506 # globally unique value that identifies the infrastructure. For Google API
507 # infrastructure, the error domain is &quot;googleapis.com&quot;.
508 &quot;metadatas&quot;: { # Additional structured details about this error.
509 #
510 # Keys must match a regular expression of `a-z+` but should
511 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
512 # length. When identifying the current value of an exceeded limit, the units
513 # should be contained in the key, not the value. For example, rather than
514 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
515 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
516 # instances that can be created in a single (batch) request.
517 &quot;a_key&quot;: &quot;A String&quot;,
518 },
519 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
520 # proximate cause of the error. Error reasons are unique within a particular
521 # domain of errors. This should be at most 63 characters and match a
522 # regular expression of `A-Z+[A-Z0-9]`, which represents
523 # UPPER_SNAKE_CASE.
524 },
525 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
526 #
527 # For example, if a quota check failed with an error indicating the calling
528 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
529 # directly to the right place in the developer console to flip the bit.
530 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
531 { # Describes a URL link.
532 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
533 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
534 },
535 ],
536 },
537 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
538 # which can be attached to an RPC error.
539 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
540 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
541 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
542 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
543 },
544 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
545 &quot;dimensions&quot;: { # The map holding related quota dimensions.
546 &quot;a_key&quot;: &quot;A String&quot;,
547 },
548 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
549 # type or metric.
550 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
551 # or metric.
552 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
553 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
554 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
555 },
556 },
557 ],
558 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
559 # This property is optional.
560 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
561 },
562 ],
563 },
564 &quot;getVersionOperationMetadata&quot;: {
565 &quot;inlineSbomInfo&quot;: {
566 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
567 # appropriate identifiers.
568 &quot;a_key&quot;: &quot;A String&quot;,
569 },
570 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
571 # identifiers.
572 &quot;a_key&quot;: &quot;A String&quot;,
573 },
574 },
575 },
576 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
577 # message that was returned, such as `NOT FOUND`.
578 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
579 # status code that was returned. For example, a `404` means the
580 # resource was not found.
581 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
582 # defined by the server.
583 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
584 # This value is inRFC3339
585 # text format.
586 &quot;instancesBulkInsertOperationMetadata&quot;: {
587 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
588 # Example key: zones/us-central1-a
589 &quot;a_key&quot;: {
590 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
591 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
592 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
593 # error.
594 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
595 # if the flow is rolling forward or rolling back.
596 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
597 },
598 },
599 },
600 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
601 # Operation resources.
602 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
603 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
604 # group of operations results from a `bulkInsert` API request.
605 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
606 # `update`, or `delete`, and so on.
607 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
608 # There is no requirement that this be linear or support any granularity of
609 # operations. This should not be used to guess when the operation will be
610 # complete. This number should monotonically increase as the operation
611 # progresses.
612 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
613 # applicable when performing regional operations.
614 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
615 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
616 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
617 # this field will contain information on all underlying zonal actions and
618 # their state.
619 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
620 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
621 # Example key: zones/us-central1-a
622 &quot;a_key&quot;: {
623 &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
624 # populated.
625 # different programming environments, including REST APIs and RPC APIs. It is
626 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
627 # three pieces of data: error code, error message, and error details.
628 #
629 # You can find out more about this error model and how to work with it in the
630 # [API Design Guide](https://cloud.google.com/apis/design/errors).
631 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
632 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
633 # message types for APIs to use.
634 {
635 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
636 },
637 ],
638 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
639 # user-facing error message should be localized and sent in the
640 # google.rpc.Status.details field, or localized by the client.
641 },
642 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
643 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
644 },
645 },
646 },
647 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
648 # This value is inRFC3339
649 # text format.
650 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
651 # following:
652 # `PENDING`, `RUNNING`, or `DONE`.
653 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
654 # operation.
655 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
656 # of the target resource.
657 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
658 # operations related to creating a snapshot, this points to the disk
659 # that the snapshot was created from.
660 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
661 # `[email protected]` or
662 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
663 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
664 # operation, this field will be populated.
665 {
666 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
667 # Engine returns NO_RESULTS_ON_PAGE if there
668 # are no results in the response.
669 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
670 # value format. For example:
671 #
672 # &quot;data&quot;: [
673 # {
674 # &quot;key&quot;: &quot;scope&quot;,
675 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
676 # }
677 {
678 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
679 # returned. For example, for warnings where there are no results in a list
680 # request for a particular zone, this key might be scope and
681 # the key value might be the zone name. Other examples might be a key
682 # indicating a deprecated resource and a suggested replacement, or a
683 # warning about invalid network settings (for example, if an instance
684 # attempts to perform IP forwarding but is not enabled for IP forwarding).
685 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
686 },
687 ],
688 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
689 },
690 ],
691 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
692 # applicable when performing per-zone operations.
693 }</pre>
694 </div>
695
696 <div class="method">
697 <code class="details" id="close">close()</code>
698 <pre>Close httplib2 connections.</pre>
699 </div>
700
701 <div class="method">
702 <code class="details" id="delete">delete(project, rollout, requestId=None, x__xgafv=None)</code>
703 <pre>Deletes a Rollout.
704
705 Args:
706 project: string, Project ID for this request. (required)
707 rollout: string, Name of the Rollout resource to delete. (required)
708 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
709 that if you must retry your request, the server will know to ignore the
710 request if it has already been completed.
711
712 For example, consider a situation where you make an initial request and
713 the request times out. If you make the request again with the same
714 request ID, the server can check if original operation with the same
715 request ID was received, and if so, will ignore the second request. This
716 prevents clients from accidentally creating duplicate commitments.
717
718 The request ID must be
719 a valid UUID with the exception that zero UUID is not supported
720 (00000000-0000-0000-0000-000000000000).
721 x__xgafv: string, V1 error format.
722 Allowed values
723 1 - v1 error format
724 2 - v2 error format
725
726 Returns:
727 An object of the form:
728
729 { # Represents an Operation resource.
730 #
731 # Google Compute Engine has three Operation resources:
732 #
733 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
734 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
735 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
736 #
737 # You can use an operation resource to manage asynchronous API requests.
738 # For more information, readHandling
739 # API responses.
740 #
741 # Operations can be global, regional or zonal.
742 #
743 # - For global operations, use the `globalOperations`
744 # resource.
745 # - For regional operations, use the
746 # `regionOperations` resource.
747 # - For zonal operations, use
748 # the `zoneOperations` resource.
749 #
750 #
751 #
752 # For more information, read
753 # Global, Regional, and Zonal Resources.
754 #
755 # Note that completed Operation resources have a limited
756 # retention period.
757 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
758 # Not present otherwise.
759 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
760 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
761 # set when the operation is created.
762 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
763 # text format.
764 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
765 # this field will be populated.
766 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
767 # operation.
768 {
769 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
770 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
771 # details. There is a set of defined message types to use for providing
772 # details.The syntax depends on the error code. For example,
773 # QuotaExceededInfo will have details when the error code is
774 # QUOTA_EXCEEDED.
775 {
776 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
777 #
778 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
779 # is not enabled:
780 #
781 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
782 # &quot;domain&quot;: &quot;googleapis.com&quot;
783 # &quot;metadata&quot;: {
784 # &quot;resource&quot;: &quot;projects/123&quot;,
785 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
786 # }
787 # }
788 #
789 # This response indicates that the pubsub.googleapis.com API is not enabled.
790 #
791 # Example of an error that is returned when attempting to create a Spanner
792 # instance in a region that is out of stock:
793 #
794 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
795 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
796 # &quot;metadata&quot;: {
797 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
798 # }
799 # }
800 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
801 # is typically the registered service name of the tool or product that
802 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
803 # generated by some common infrastructure, the error domain must be a
804 # globally unique value that identifies the infrastructure. For Google API
805 # infrastructure, the error domain is &quot;googleapis.com&quot;.
806 &quot;metadatas&quot;: { # Additional structured details about this error.
807 #
808 # Keys must match a regular expression of `a-z+` but should
809 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
810 # length. When identifying the current value of an exceeded limit, the units
811 # should be contained in the key, not the value. For example, rather than
812 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
813 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
814 # instances that can be created in a single (batch) request.
815 &quot;a_key&quot;: &quot;A String&quot;,
816 },
817 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
818 # proximate cause of the error. Error reasons are unique within a particular
819 # domain of errors. This should be at most 63 characters and match a
820 # regular expression of `A-Z+[A-Z0-9]`, which represents
821 # UPPER_SNAKE_CASE.
822 },
823 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
824 #
825 # For example, if a quota check failed with an error indicating the calling
826 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
827 # directly to the right place in the developer console to flip the bit.
828 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
829 { # Describes a URL link.
830 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
831 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
832 },
833 ],
834 },
835 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
836 # which can be attached to an RPC error.
837 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
838 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
839 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
840 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
841 },
842 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
843 &quot;dimensions&quot;: { # The map holding related quota dimensions.
844 &quot;a_key&quot;: &quot;A String&quot;,
845 },
846 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
847 # type or metric.
848 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
849 # or metric.
850 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
851 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
852 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
853 },
854 },
855 ],
856 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
857 # This property is optional.
858 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
859 },
860 ],
861 },
862 &quot;getVersionOperationMetadata&quot;: {
863 &quot;inlineSbomInfo&quot;: {
864 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
865 # appropriate identifiers.
866 &quot;a_key&quot;: &quot;A String&quot;,
867 },
868 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
869 # identifiers.
870 &quot;a_key&quot;: &quot;A String&quot;,
871 },
872 },
873 },
874 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
875 # message that was returned, such as `NOT FOUND`.
876 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
877 # status code that was returned. For example, a `404` means the
878 # resource was not found.
879 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
880 # defined by the server.
881 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
882 # This value is inRFC3339
883 # text format.
884 &quot;instancesBulkInsertOperationMetadata&quot;: {
885 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
886 # Example key: zones/us-central1-a
887 &quot;a_key&quot;: {
888 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
889 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
890 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
891 # error.
892 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
893 # if the flow is rolling forward or rolling back.
894 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
895 },
896 },
897 },
898 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
899 # Operation resources.
900 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
901 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
902 # group of operations results from a `bulkInsert` API request.
903 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
904 # `update`, or `delete`, and so on.
905 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
906 # There is no requirement that this be linear or support any granularity of
907 # operations. This should not be used to guess when the operation will be
908 # complete. This number should monotonically increase as the operation
909 # progresses.
910 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
911 # applicable when performing regional operations.
912 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
913 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
914 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
915 # this field will contain information on all underlying zonal actions and
916 # their state.
917 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
918 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
919 # Example key: zones/us-central1-a
920 &quot;a_key&quot;: {
921 &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
922 # populated.
923 # different programming environments, including REST APIs and RPC APIs. It is
924 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
925 # three pieces of data: error code, error message, and error details.
926 #
927 # You can find out more about this error model and how to work with it in the
928 # [API Design Guide](https://cloud.google.com/apis/design/errors).
929 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
930 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
931 # message types for APIs to use.
932 {
933 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
934 },
935 ],
936 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
937 # user-facing error message should be localized and sent in the
938 # google.rpc.Status.details field, or localized by the client.
939 },
940 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
941 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
942 },
943 },
944 },
945 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
946 # This value is inRFC3339
947 # text format.
948 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
949 # following:
950 # `PENDING`, `RUNNING`, or `DONE`.
951 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
952 # operation.
953 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
954 # of the target resource.
955 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
956 # operations related to creating a snapshot, this points to the disk
957 # that the snapshot was created from.
958 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
959 # `[email protected]` or
960 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
961 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
962 # operation, this field will be populated.
963 {
964 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
965 # Engine returns NO_RESULTS_ON_PAGE if there
966 # are no results in the response.
967 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
968 # value format. For example:
969 #
970 # &quot;data&quot;: [
971 # {
972 # &quot;key&quot;: &quot;scope&quot;,
973 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
974 # }
975 {
976 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
977 # returned. For example, for warnings where there are no results in a list
978 # request for a particular zone, this key might be scope and
979 # the key value might be the zone name. Other examples might be a key
980 # indicating a deprecated resource and a suggested replacement, or a
981 # warning about invalid network settings (for example, if an instance
982 # attempts to perform IP forwarding but is not enabled for IP forwarding).
983 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
984 },
985 ],
986 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
987 },
988 ],
989 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
990 # applicable when performing per-zone operations.
991 }</pre>
992 </div>
993
994 <div class="method">
995 <code class="details" id="get">get(project, rollout, x__xgafv=None)</code>
996 <pre>Gets details of a single project-scoped Rollout.
997
998 Args:
999 project: string, Project ID for this request. (required)
1000 rollout: string, Name of the persistent rollout to return. (required)
1001 x__xgafv: string, V1 error format.
1002 Allowed values
1003 1 - v1 error format
1004 2 - v2 error format
1005
1006 Returns:
1007 An object of the form:
1008
1009 { # Rollout resource.
1010 #
1011 # A Rollout is a specific instance of a RolloutPlan. It represents a single
1012 # execution of a strategy to roll out a specific resource. It also provides
1013 # APIs to interact with the rollout.
1014 &quot;cancellationTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was cancelled.
1015 &quot;completionTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was completed.
1016 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1017 # text format.
1018 &quot;currentWaveNumber&quot;: &quot;A String&quot;, # Output only. The number of the currently running wave.
1019 # Ex. 1
1020 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1021 # create the resource.
1022 &quot;etag&quot;: &quot;A String&quot;, # Output only. etag of the Rollout
1023 # Ex. abc1234
1024 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1025 # defined by the server.
1026 &quot;kind&quot;: &quot;compute#rollout&quot;, # Output only. [Output Only] Type of the resource. Always compute#rollout
1027 # for rollouts.
1028 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1029 # The name must be 1-63 characters long, and comply withRFC1035.
1030 # Specifically, the name must be 1-63 characters long and match the regular
1031 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
1032 # which means the first character must be a lowercase letter, and all
1033 # following characters must be a dash, lowercase letter, or digit, except
1034 # the last character, which cannot be a dash.
1035 &quot;pauseTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was paused.
1036 &quot;resumeTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was resumed.
1037 &quot;rolloutEntity&quot;: { # Specifications of the resource to roll out. # Required. The resource being rolled out.
1038 &quot;orchestratedEntity&quot;: { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
1039 # integration model with ProgressiveRollout.
1040 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Required. Specifies the behavior of the Rollout if an out of band update is
1041 # detected in a project during a Rollout. It can be one of the following
1042 # values:
1043 # 1) overwrite : Overwrite the local value with the rollout value.
1044 # 2) no_overwrite : Do not overwrite the local value with the rollout
1045 # value.
1046 &quot;orchestrationAction&quot;: &quot;A String&quot;, # Required. Orchestration action during the Rollout. It can be one of the following
1047 # values:
1048 # 1) &quot;update&quot;: Resources will be updated by the rollout.
1049 # 2) &quot;delete&quot;: Resources will be deleted by the rollout.
1050 &quot;orchestrationSource&quot;: &quot;A String&quot;, # Required. Fully qualified resource name of the resource which contains the source
1051 # of truth of the configuration being rolled out across
1052 # locations/projects. For example, in the case of a global Rollout which
1053 # is applied across regions, this contains the name of the global
1054 # resource created by the user which contains a payload for a resource
1055 # that is orchestrated across regions. This follows the following format:
1056 # //.googleapis.com/projects//locations/global//
1057 # e.g.
1058 # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
1059 },
1060 },
1061 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Required. Rollout Plan used to model the Rollout.
1062 # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
1063 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1064 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1065 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the Rollout.
1066 &quot;waveDetails&quot;: [ # Output only. Details about each wave of the rollout.
1067 { # Additional metadata about the status of each wave provided by the server.
1068 &quot;orchestratedWaveDetails&quot;: { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
1069 # Integration model.
1070 # model.
1071 &quot;completedResourcesCount&quot;: &quot;A String&quot;, # Output only. Resource completed so far.
1072 &quot;estimatedCompletionTime&quot;: &quot;A String&quot;, # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
1073 # current progress.
1074 &quot;estimatedTotalResourcesCount&quot;: &quot;A String&quot;, # Output only. Estimated total count of resources.
1075 &quot;failedLocations&quot;: [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
1076 # stopped retrying. There may be some successful resources rolled out in
1077 # the wave as the location may have failed later in the Rollout.
1078 &quot;A String&quot;,
1079 ],
1080 &quot;failedResourcesCount&quot;: &quot;A String&quot;, # Output only. Resources failed.
1081 &quot;locationStatus&quot;: { # Output only. Status of each location in the wave. Map keys (locations) must be
1082 # specified like &quot;us-east1&quot; or &quot;asia-west1-a&quot;.
1083 &quot;a_key&quot;: { # Represents the status of a location in a wave.
1084 &quot;state&quot;: &quot;A String&quot;, # Output only. Location state of the wave.
1085 },
1086 },
1087 },
1088 &quot;waveDisplayName&quot;: &quot;A String&quot;, # Output only. Wave name.
1089 # Ex. wave1
1090 &quot;waveNumber&quot;: &quot;A String&quot;, # Output only. System generated number for the wave.
1091 },
1092 ],
1093 }</pre>
1094 </div>
1095
1096 <div class="method">
1097 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
1098 <pre>Lists Rollouts in a given project and location.
1099
1100 Args:
1101 project: string, Project ID for this request. (required)
1102 filter: string, A filter expression that filters resources listed in the response. Most
1103 Compute resources support two types of filter expressions:
1104 expressions that support regular expressions and expressions that follow
1105 API improvement proposal AIP-160.
1106 These two types of filter expressions cannot be mixed in one request.
1107
1108 If you want to use AIP-160, your expression must specify the field name, an
1109 operator, and the value that you want to use for filtering. The value
1110 must be a string, a number, or a boolean. The operator
1111 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
1112
1113 For example, if you are filtering Compute Engine instances, you can
1114 exclude instances named `example-instance` by specifying
1115 `name != example-instance`.
1116
1117 The `:*` comparison can be used to test whether a key has been defined.
1118 For example, to find all objects with `owner` label use:
1119 ```
1120 labels.owner:*
1121 ```
1122
1123 You can also filter nested fields. For example, you could specify
1124 `scheduling.automaticRestart = false` to include instances only
1125 if they are not scheduled for automatic restarts. You can use filtering
1126 on nested fields to filter based onresource labels.
1127
1128 To filter on multiple expressions, provide each separate expression within
1129 parentheses. For example:
1130 ```
1131 (scheduling.automaticRestart = true)
1132 (cpuPlatform = &quot;Intel Skylake&quot;)
1133 ```
1134 By default, each expression is an `AND` expression. However, you
1135 can include `AND` and `OR` expressions explicitly.
1136 For example:
1137 ```
1138 (cpuPlatform = &quot;Intel Skylake&quot;) OR
1139 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
1140 (scheduling.automaticRestart = true)
1141 ```
1142
1143 If you want to use a regular expression, use the `eq` (equal) or `ne`
1144 (not equal) operator against a single un-parenthesized expression with or
1145 without quotes or against multiple parenthesized expressions. Examples:
1146
1147 `fieldname eq unquoted literal`
1148 `fieldname eq &#x27;single quoted literal&#x27;`
1149 `fieldname eq &quot;double quoted literal&quot;`
1150 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
1151
1152 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
1153 The literal value must match the entire field.
1154
1155 For example, to filter for instances that do not end with name &quot;instance&quot;,
1156 you would use `name ne .*instance`.
1157
1158 You cannot combine constraints on multiple fields using regular
1159 expressions.
1160 maxResults: integer, The maximum number of results per page that should be returned.
1161 If the number of available results is larger than `maxResults`,
1162 Compute Engine returns a `nextPageToken` that can be used to get
1163 the next page of results in subsequent list requests. Acceptable values are
1164 `0` to `500`, inclusive. (Default: `500`)
1165 orderBy: string, Sorts list results by a certain order. By default, results
1166 are returned in alphanumerical order based on the resource name.
1167
1168 You can also sort results in descending order based on the creation
1169 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
1170 results based on the `creationTimestamp` field in
1171 reverse chronological order (newest result first). Use this to sort
1172 resources like operations so that the newest operation is returned first.
1173
1174 Currently, only sorting by `name` or
1175 `creationTimestamp desc` is supported.
1176 pageToken: string, Specifies a page token to use. Set `pageToken` to the
1177 `nextPageToken` returned by a previous list request to get
1178 the next page of results.
1179 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
1180 of failure. The default value is false.
1181
1182 For example, when partial success behavior is enabled, aggregatedList for a
1183 single zone scope either returns all resources in the zone or no resources,
1184 with an error code.
1185 x__xgafv: string, V1 error format.
1186 Allowed values
1187 1 - v1 error format
1188 2 - v2 error format
1189
1190 Returns:
1191 An object of the form:
1192
1193 {
1194 &quot;etag&quot;: &quot;A String&quot;,
1195 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
1196 &quot;items&quot;: [ # A list of Rollout resources.
1197 { # Rollout resource.
1198 #
1199 # A Rollout is a specific instance of a RolloutPlan. It represents a single
1200 # execution of a strategy to roll out a specific resource. It also provides
1201 # APIs to interact with the rollout.
1202 &quot;cancellationTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was cancelled.
1203 &quot;completionTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was completed.
1204 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1205 # text format.
1206 &quot;currentWaveNumber&quot;: &quot;A String&quot;, # Output only. The number of the currently running wave.
1207 # Ex. 1
1208 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1209 # create the resource.
1210 &quot;etag&quot;: &quot;A String&quot;, # Output only. etag of the Rollout
1211 # Ex. abc1234
1212 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1213 # defined by the server.
1214 &quot;kind&quot;: &quot;compute#rollout&quot;, # Output only. [Output Only] Type of the resource. Always compute#rollout
1215 # for rollouts.
1216 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
1217 # The name must be 1-63 characters long, and comply withRFC1035.
1218 # Specifically, the name must be 1-63 characters long and match the regular
1219 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
1220 # which means the first character must be a lowercase letter, and all
1221 # following characters must be a dash, lowercase letter, or digit, except
1222 # the last character, which cannot be a dash.
1223 &quot;pauseTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was paused.
1224 &quot;resumeTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which the Rollout was resumed.
1225 &quot;rolloutEntity&quot;: { # Specifications of the resource to roll out. # Required. The resource being rolled out.
1226 &quot;orchestratedEntity&quot;: { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
1227 # integration model with ProgressiveRollout.
1228 &quot;conflictBehavior&quot;: &quot;A String&quot;, # Required. Specifies the behavior of the Rollout if an out of band update is
1229 # detected in a project during a Rollout. It can be one of the following
1230 # values:
1231 # 1) overwrite : Overwrite the local value with the rollout value.
1232 # 2) no_overwrite : Do not overwrite the local value with the rollout
1233 # value.
1234 &quot;orchestrationAction&quot;: &quot;A String&quot;, # Required. Orchestration action during the Rollout. It can be one of the following
1235 # values:
1236 # 1) &quot;update&quot;: Resources will be updated by the rollout.
1237 # 2) &quot;delete&quot;: Resources will be deleted by the rollout.
1238 &quot;orchestrationSource&quot;: &quot;A String&quot;, # Required. Fully qualified resource name of the resource which contains the source
1239 # of truth of the configuration being rolled out across
1240 # locations/projects. For example, in the case of a global Rollout which
1241 # is applied across regions, this contains the name of the global
1242 # resource created by the user which contains a payload for a resource
1243 # that is orchestrated across regions. This follows the following format:
1244 # //.googleapis.com/projects//locations/global//
1245 # e.g.
1246 # //osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1
1247 },
1248 },
1249 &quot;rolloutPlan&quot;: &quot;A String&quot;, # Required. Rollout Plan used to model the Rollout.
1250 # Ex. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1
1251 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
1252 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1253 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the Rollout.
1254 &quot;waveDetails&quot;: [ # Output only. Details about each wave of the rollout.
1255 { # Additional metadata about the status of each wave provided by the server.
1256 &quot;orchestratedWaveDetails&quot;: { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
1257 # Integration model.
1258 # model.
1259 &quot;completedResourcesCount&quot;: &quot;A String&quot;, # Output only. Resource completed so far.
1260 &quot;estimatedCompletionTime&quot;: &quot;A String&quot;, # Output only. Estimated timestamp at which the wave will complete. Extrapolated from
1261 # current progress.
1262 &quot;estimatedTotalResourcesCount&quot;: &quot;A String&quot;, # Output only. Estimated total count of resources.
1263 &quot;failedLocations&quot;: [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
1264 # stopped retrying. There may be some successful resources rolled out in
1265 # the wave as the location may have failed later in the Rollout.
1266 &quot;A String&quot;,
1267 ],
1268 &quot;failedResourcesCount&quot;: &quot;A String&quot;, # Output only. Resources failed.
1269 &quot;locationStatus&quot;: { # Output only. Status of each location in the wave. Map keys (locations) must be
1270 # specified like &quot;us-east1&quot; or &quot;asia-west1-a&quot;.
1271 &quot;a_key&quot;: { # Represents the status of a location in a wave.
1272 &quot;state&quot;: &quot;A String&quot;, # Output only. Location state of the wave.
1273 },
1274 },
1275 },
1276 &quot;waveDisplayName&quot;: &quot;A String&quot;, # Output only. Wave name.
1277 # Ex. wave1
1278 &quot;waveNumber&quot;: &quot;A String&quot;, # Output only. System generated number for the wave.
1279 },
1280 ],
1281 },
1282 ],
1283 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1284 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1285 # the query parameter pageToken in the next list request.
1286 # Subsequent list requests will have their own nextPageToken to
1287 # continue paging through the results.
1288 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1289 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1290 # end_interface: MixerListResponseWithEtagBuilder
1291 &quot;A String&quot;,
1292 ],
1293 &quot;warning&quot;: { # [Output Only] Informational warning message.
1294 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1295 # Engine returns NO_RESULTS_ON_PAGE if there
1296 # are no results in the response.
1297 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1298 # value format. For example:
1299 #
1300 # &quot;data&quot;: [
1301 # {
1302 # &quot;key&quot;: &quot;scope&quot;,
1303 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1304 # }
1305 {
1306 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1307 # returned. For example, for warnings where there are no results in a list
1308 # request for a particular zone, this key might be scope and
1309 # the key value might be the zone name. Other examples might be a key
1310 # indicating a deprecated resource and a suggested replacement, or a
1311 # warning about invalid network settings (for example, if an instance
1312 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1313 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1314 },
1315 ],
1316 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1317 },
1318 }</pre>
1319 </div>
1320
1321 <div class="method">
1322 <code class="details" id="list_next">list_next()</code>
1323 <pre>Retrieves the next page of results.
1324
1325 Args:
1326 previous_request: The request for the previous page. (required)
1327 previous_response: The response from the request for the previous page. (required)
1328
1329 Returns:
1330 A request object that you can call &#x27;execute()&#x27; on to request the next
1331 page. Returns None if there are no more items in the collection.
1332 </pre>
1333 </div>
1334
1335 <div class="method">
1336 <code class="details" id="pause">pause(project, rollout, etag=None, requestId=None, x__xgafv=None)</code>
1337 <pre>Pauses a Rollout.
1338
1339 Args:
1340 project: string, Required. Project ID for this request. (required)
1341 rollout: string, Required. Name of the Rollout resource to pause. (required)
1342 etag: string, The etag of the Rollout.
1343 If this is provided, the request will only succeed if the etag matches
1344 the current etag of the Rollout.
1345 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1346 that if you must retry your request, the server will know to ignore the
1347 request if it has already been completed.
1348
1349 For example, consider a situation where you make an initial request and
1350 the request times out. If you make the request again with the same
1351 request ID, the server can check if original operation with the same
1352 request ID was received, and if so, will ignore the second request. This
1353 prevents clients from accidentally creating duplicate commitments.
1354
1355 The request ID must be
1356 a valid UUID with the exception that zero UUID is not supported
1357 (00000000-0000-0000-0000-000000000000).
1358 x__xgafv: string, V1 error format.
1359 Allowed values
1360 1 - v1 error format
1361 2 - v2 error format
1362
1363 Returns:
1364 An object of the form:
1365
1366 { # Represents an Operation resource.
1367 #
1368 # Google Compute Engine has three Operation resources:
1369 #
1370 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1371 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1372 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1373 #
1374 # You can use an operation resource to manage asynchronous API requests.
1375 # For more information, readHandling
1376 # API responses.
1377 #
1378 # Operations can be global, regional or zonal.
1379 #
1380 # - For global operations, use the `globalOperations`
1381 # resource.
1382 # - For regional operations, use the
1383 # `regionOperations` resource.
1384 # - For zonal operations, use
1385 # the `zoneOperations` resource.
1386 #
1387 #
1388 #
1389 # For more information, read
1390 # Global, Regional, and Zonal Resources.
1391 #
1392 # Note that completed Operation resources have a limited
1393 # retention period.
1394 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1395 # Not present otherwise.
1396 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1397 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1398 # set when the operation is created.
1399 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1400 # text format.
1401 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1402 # this field will be populated.
1403 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1404 # operation.
1405 {
1406 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1407 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1408 # details. There is a set of defined message types to use for providing
1409 # details.The syntax depends on the error code. For example,
1410 # QuotaExceededInfo will have details when the error code is
1411 # QUOTA_EXCEEDED.
1412 {
1413 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1414 #
1415 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1416 # is not enabled:
1417 #
1418 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1419 # &quot;domain&quot;: &quot;googleapis.com&quot;
1420 # &quot;metadata&quot;: {
1421 # &quot;resource&quot;: &quot;projects/123&quot;,
1422 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1423 # }
1424 # }
1425 #
1426 # This response indicates that the pubsub.googleapis.com API is not enabled.
1427 #
1428 # Example of an error that is returned when attempting to create a Spanner
1429 # instance in a region that is out of stock:
1430 #
1431 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1432 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1433 # &quot;metadata&quot;: {
1434 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1435 # }
1436 # }
1437 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1438 # is typically the registered service name of the tool or product that
1439 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1440 # generated by some common infrastructure, the error domain must be a
1441 # globally unique value that identifies the infrastructure. For Google API
1442 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1443 &quot;metadatas&quot;: { # Additional structured details about this error.
1444 #
1445 # Keys must match a regular expression of `a-z+` but should
1446 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1447 # length. When identifying the current value of an exceeded limit, the units
1448 # should be contained in the key, not the value. For example, rather than
1449 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1450 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1451 # instances that can be created in a single (batch) request.
1452 &quot;a_key&quot;: &quot;A String&quot;,
1453 },
1454 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1455 # proximate cause of the error. Error reasons are unique within a particular
1456 # domain of errors. This should be at most 63 characters and match a
1457 # regular expression of `A-Z+[A-Z0-9]`, which represents
1458 # UPPER_SNAKE_CASE.
1459 },
1460 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1461 #
1462 # For example, if a quota check failed with an error indicating the calling
1463 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1464 # directly to the right place in the developer console to flip the bit.
1465 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1466 { # Describes a URL link.
1467 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1468 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1469 },
1470 ],
1471 },
1472 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1473 # which can be attached to an RPC error.
1474 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1475 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1476 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1477 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1478 },
1479 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1480 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1481 &quot;a_key&quot;: &quot;A String&quot;,
1482 },
1483 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1484 # type or metric.
1485 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1486 # or metric.
1487 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1488 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1489 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1490 },
1491 },
1492 ],
1493 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1494 # This property is optional.
1495 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1496 },
1497 ],
1498 },
1499 &quot;getVersionOperationMetadata&quot;: {
1500 &quot;inlineSbomInfo&quot;: {
1501 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1502 # appropriate identifiers.
1503 &quot;a_key&quot;: &quot;A String&quot;,
1504 },
1505 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1506 # identifiers.
1507 &quot;a_key&quot;: &quot;A String&quot;,
1508 },
1509 },
1510 },
1511 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1512 # message that was returned, such as `NOT FOUND`.
1513 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1514 # status code that was returned. For example, a `404` means the
1515 # resource was not found.
1516 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1517 # defined by the server.
1518 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1519 # This value is inRFC3339
1520 # text format.
1521 &quot;instancesBulkInsertOperationMetadata&quot;: {
1522 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1523 # Example key: zones/us-central1-a
1524 &quot;a_key&quot;: {
1525 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1526 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1527 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1528 # error.
1529 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1530 # if the flow is rolling forward or rolling back.
1531 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1532 },
1533 },
1534 },
1535 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1536 # Operation resources.
1537 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1538 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1539 # group of operations results from a `bulkInsert` API request.
1540 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1541 # `update`, or `delete`, and so on.
1542 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1543 # There is no requirement that this be linear or support any granularity of
1544 # operations. This should not be used to guess when the operation will be
1545 # complete. This number should monotonically increase as the operation
1546 # progresses.
1547 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1548 # applicable when performing regional operations.
1549 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1550 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1551 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1552 # this field will contain information on all underlying zonal actions and
1553 # their state.
1554 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1555 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1556 # Example key: zones/us-central1-a
1557 &quot;a_key&quot;: {
1558 &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
1559 # populated.
1560 # different programming environments, including REST APIs and RPC APIs. It is
1561 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1562 # three pieces of data: error code, error message, and error details.
1563 #
1564 # You can find out more about this error model and how to work with it in the
1565 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1566 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1567 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1568 # message types for APIs to use.
1569 {
1570 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1571 },
1572 ],
1573 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1574 # user-facing error message should be localized and sent in the
1575 # google.rpc.Status.details field, or localized by the client.
1576 },
1577 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1578 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1579 },
1580 },
1581 },
1582 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1583 # This value is inRFC3339
1584 # text format.
1585 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1586 # following:
1587 # `PENDING`, `RUNNING`, or `DONE`.
1588 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1589 # operation.
1590 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1591 # of the target resource.
1592 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1593 # operations related to creating a snapshot, this points to the disk
1594 # that the snapshot was created from.
1595 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1596 # `[email protected]` or
1597 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1598 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1599 # operation, this field will be populated.
1600 {
1601 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1602 # Engine returns NO_RESULTS_ON_PAGE if there
1603 # are no results in the response.
1604 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1605 # value format. For example:
1606 #
1607 # &quot;data&quot;: [
1608 # {
1609 # &quot;key&quot;: &quot;scope&quot;,
1610 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1611 # }
1612 {
1613 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1614 # returned. For example, for warnings where there are no results in a list
1615 # request for a particular zone, this key might be scope and
1616 # the key value might be the zone name. Other examples might be a key
1617 # indicating a deprecated resource and a suggested replacement, or a
1618 # warning about invalid network settings (for example, if an instance
1619 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1620 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1621 },
1622 ],
1623 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1624 },
1625 ],
1626 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1627 # applicable when performing per-zone operations.
1628 }</pre>
1629 </div>
1630
1631 <div class="method">
1632 <code class="details" id="resume">resume(project, rollout, etag=None, requestId=None, x__xgafv=None)</code>
1633 <pre>Resumes a Rollout.
1634
1635 Args:
1636 project: string, Required. Project ID for this request. (required)
1637 rollout: string, Required. Name of the Rollout resource to resume. (required)
1638 etag: string, The etag of the Rollout.
1639 If this is provided, the request will only succeed if the etag matches
1640 the current etag of the Rollout.
1641 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1642 that if you must retry your request, the server will know to ignore the
1643 request if it has already been completed.
1644
1645 For example, consider a situation where you make an initial request and
1646 the request times out. If you make the request again with the same
1647 request ID, the server can check if original operation with the same
1648 request ID was received, and if so, will ignore the second request. This
1649 prevents clients from accidentally creating duplicate commitments.
1650
1651 The request ID must be
1652 a valid UUID with the exception that zero UUID is not supported
1653 (00000000-0000-0000-0000-000000000000).
1654 x__xgafv: string, V1 error format.
1655 Allowed values
1656 1 - v1 error format
1657 2 - v2 error format
1658
1659 Returns:
1660 An object of the form:
1661
1662 { # Represents an Operation resource.
1663 #
1664 # Google Compute Engine has three Operation resources:
1665 #
1666 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
1667 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
1668 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
1669 #
1670 # You can use an operation resource to manage asynchronous API requests.
1671 # For more information, readHandling
1672 # API responses.
1673 #
1674 # Operations can be global, regional or zonal.
1675 #
1676 # - For global operations, use the `globalOperations`
1677 # resource.
1678 # - For regional operations, use the
1679 # `regionOperations` resource.
1680 # - For zonal operations, use
1681 # the `zoneOperations` resource.
1682 #
1683 #
1684 #
1685 # For more information, read
1686 # Global, Regional, and Zonal Resources.
1687 #
1688 # Note that completed Operation resources have a limited
1689 # retention period.
1690 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1691 # Not present otherwise.
1692 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1693 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1694 # set when the operation is created.
1695 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1696 # text format.
1697 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1698 # this field will be populated.
1699 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1700 # operation.
1701 {
1702 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1703 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1704 # details. There is a set of defined message types to use for providing
1705 # details.The syntax depends on the error code. For example,
1706 # QuotaExceededInfo will have details when the error code is
1707 # QUOTA_EXCEEDED.
1708 {
1709 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1710 #
1711 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1712 # is not enabled:
1713 #
1714 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1715 # &quot;domain&quot;: &quot;googleapis.com&quot;
1716 # &quot;metadata&quot;: {
1717 # &quot;resource&quot;: &quot;projects/123&quot;,
1718 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1719 # }
1720 # }
1721 #
1722 # This response indicates that the pubsub.googleapis.com API is not enabled.
1723 #
1724 # Example of an error that is returned when attempting to create a Spanner
1725 # instance in a region that is out of stock:
1726 #
1727 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1728 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1729 # &quot;metadata&quot;: {
1730 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1731 # }
1732 # }
1733 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1734 # is typically the registered service name of the tool or product that
1735 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1736 # generated by some common infrastructure, the error domain must be a
1737 # globally unique value that identifies the infrastructure. For Google API
1738 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1739 &quot;metadatas&quot;: { # Additional structured details about this error.
1740 #
1741 # Keys must match a regular expression of `a-z+` but should
1742 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1743 # length. When identifying the current value of an exceeded limit, the units
1744 # should be contained in the key, not the value. For example, rather than
1745 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1746 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1747 # instances that can be created in a single (batch) request.
1748 &quot;a_key&quot;: &quot;A String&quot;,
1749 },
1750 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1751 # proximate cause of the error. Error reasons are unique within a particular
1752 # domain of errors. This should be at most 63 characters and match a
1753 # regular expression of `A-Z+[A-Z0-9]`, which represents
1754 # UPPER_SNAKE_CASE.
1755 },
1756 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1757 #
1758 # For example, if a quota check failed with an error indicating the calling
1759 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1760 # directly to the right place in the developer console to flip the bit.
1761 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1762 { # Describes a URL link.
1763 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1764 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1765 },
1766 ],
1767 },
1768 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1769 # which can be attached to an RPC error.
1770 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1771 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1772 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1773 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1774 },
1775 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1776 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1777 &quot;a_key&quot;: &quot;A String&quot;,
1778 },
1779 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1780 # type or metric.
1781 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1782 # or metric.
1783 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1784 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1785 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1786 },
1787 },
1788 ],
1789 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1790 # This property is optional.
1791 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1792 },
1793 ],
1794 },
1795 &quot;getVersionOperationMetadata&quot;: {
1796 &quot;inlineSbomInfo&quot;: {
1797 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1798 # appropriate identifiers.
1799 &quot;a_key&quot;: &quot;A String&quot;,
1800 },
1801 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1802 # identifiers.
1803 &quot;a_key&quot;: &quot;A String&quot;,
1804 },
1805 },
1806 },
1807 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1808 # message that was returned, such as `NOT FOUND`.
1809 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1810 # status code that was returned. For example, a `404` means the
1811 # resource was not found.
1812 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1813 # defined by the server.
1814 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1815 # This value is inRFC3339
1816 # text format.
1817 &quot;instancesBulkInsertOperationMetadata&quot;: {
1818 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1819 # Example key: zones/us-central1-a
1820 &quot;a_key&quot;: {
1821 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1822 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1823 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1824 # error.
1825 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1826 # if the flow is rolling forward or rolling back.
1827 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1828 },
1829 },
1830 },
1831 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1832 # Operation resources.
1833 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1834 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1835 # group of operations results from a `bulkInsert` API request.
1836 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1837 # `update`, or `delete`, and so on.
1838 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1839 # There is no requirement that this be linear or support any granularity of
1840 # operations. This should not be used to guess when the operation will be
1841 # complete. This number should monotonically increase as the operation
1842 # progresses.
1843 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1844 # applicable when performing regional operations.
1845 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1846 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
1847 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1848 # this field will contain information on all underlying zonal actions and
1849 # their state.
1850 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1851 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1852 # Example key: zones/us-central1-a
1853 &quot;a_key&quot;: {
1854 &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
1855 # populated.
1856 # different programming environments, including REST APIs and RPC APIs. It is
1857 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1858 # three pieces of data: error code, error message, and error details.
1859 #
1860 # You can find out more about this error model and how to work with it in the
1861 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1862 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1863 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1864 # message types for APIs to use.
1865 {
1866 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1867 },
1868 ],
1869 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1870 # user-facing error message should be localized and sent in the
1871 # google.rpc.Status.details field, or localized by the client.
1872 },
1873 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1874 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1875 },
1876 },
1877 },
1878 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1879 # This value is inRFC3339
1880 # text format.
1881 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1882 # following:
1883 # `PENDING`, `RUNNING`, or `DONE`.
1884 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1885 # operation.
1886 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1887 # of the target resource.
1888 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1889 # operations related to creating a snapshot, this points to the disk
1890 # that the snapshot was created from.
1891 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1892 # `[email protected]` or
1893 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1894 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1895 # operation, this field will be populated.
1896 {
1897 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1898 # Engine returns NO_RESULTS_ON_PAGE if there
1899 # are no results in the response.
1900 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1901 # value format. For example:
1902 #
1903 # &quot;data&quot;: [
1904 # {
1905 # &quot;key&quot;: &quot;scope&quot;,
1906 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1907 # }
1908 {
1909 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1910 # returned. For example, for warnings where there are no results in a list
1911 # request for a particular zone, this key might be scope and
1912 # the key value might be the zone name. Other examples might be a key
1913 # indicating a deprecated resource and a suggested replacement, or a
1914 # warning about invalid network settings (for example, if an instance
1915 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1916 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1917 },
1918 ],
1919 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1920 },
1921 ],
1922 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1923 # applicable when performing per-zone operations.
1924 }</pre>
1925 </div>
1926
1927 </body></html>