Debian Codegraph @

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