Debian Codegraph @

docs/dyn/compute_beta.disks.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.disks.html">disks</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#addResourcePolicies">addResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Adds existing resource policies to a disk. You can only add one</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves an aggregated list of persistent disks.</p>
83 <p class="toc_element">
84 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <p class="toc_element">
87 <code><a href="#bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Bulk create a set of disks.</p>
89 <p class="toc_element">
90 <code><a href="#bulkSetLabels">bulkSetLabels(project, zone, body=None, requestId=None, resource=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Sets the labels on many disks at once. To learn more about labels, read theLabeling</p>
92 <p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94 <p class="firstline">Close httplib2 connections.</p>
95 <p class="toc_element">
96 <code><a href="#createSnapshot">createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Creates a snapshot of a specified persistent disk. For regular snapshot</p>
98 <p class="toc_element">
99 <code><a href="#delete">delete(project, zone, disk, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Deletes the specified persistent disk. Deleting a disk removes its data</p>
101 <p class="toc_element">
102 <code><a href="#get">get(project, zone, disk, x__xgafv=None)</a></code></p>
103 <p class="firstline">Returns the specified persistent disk.</p>
104 <p class="toc_element">
105 <code><a href="#getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
106 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
107 <p class="toc_element">
108 <code><a href="#insert">insert(project, zone, body=None, requestId=None, sourceImage=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Creates a persistent disk in the specified project using the data</p>
110 <p class="toc_element">
111 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Retrieves a list of persistent disks contained within</p>
113 <p class="toc_element">
114 <code><a href="#list_next">list_next()</a></code></p>
115 <p class="firstline">Retrieves the next page of results.</p>
116 <p class="toc_element">
117 <code><a href="#removeResourcePolicies">removeResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Removes resource policies from a disk.</p>
119 <p class="toc_element">
120 <code><a href="#resize">resize(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Resizes the specified persistent disk.</p>
122 <p class="toc_element">
123 <code><a href="#setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Sets the access control policy on the specified resource.</p>
125 <p class="toc_element">
126 <code><a href="#setLabels">setLabels(project, zone, resource, body=None, requestId=None, x__xgafv=None)</a></code></p>
127 <p class="firstline">Sets the labels on a disk. To learn more about labels, read theLabeling</p>
128 <p class="toc_element">
129 <code><a href="#startAsyncReplication">startAsyncReplication(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
130 <p class="firstline">Starts asynchronous replication.</p>
131 <p class="toc_element">
132 <code><a href="#stopAsyncReplication">stopAsyncReplication(project, zone, disk, requestId=None, x__xgafv=None)</a></code></p>
133 <p class="firstline">Stops asynchronous replication.</p>
134 <p class="toc_element">
135 <code><a href="#stopGroupAsyncReplication">stopGroupAsyncReplication(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p>
136 <p class="firstline">Stops asynchronous replication for a consistency group of disks.</p>
137 <p class="toc_element">
138 <code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</a></code></p>
139 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
140 <p class="toc_element">
141 <code><a href="#update">update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
142 <p class="firstline">Updates the specified disk with the data included in the request.</p>
143 <p class="toc_element">
144 <code><a href="#updateKmsKey">updateKmsKey(project, zone, disk, body=None, requestId=None, x__xgafv=None)</a></code></p>
145 <p class="firstline">Rotates the customer-managed</p>
146 <h3>Method Details</h3>
147 <div class="method">
148 <code class="details" id="addResourcePolicies">addResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
149 <pre>Adds existing resource policies to a disk. You can only add one
150 policy which will be applied to this disk for scheduling snapshot
151 creation.
152
153 Args:
154 project: string, Project ID for this request. (required)
155 zone: string, The name of the zone for this request. (required)
156 disk: string, The disk name for this request. (required)
157 body: object, The request body.
158 The object takes the form of:
159
160 {
161 &quot;resourcePolicies&quot;: [ # Full or relative path to the resource policy to be added to this disk. You
162 # can only specify one resource policy.
163 &quot;A String&quot;,
164 ],
165 }
166
167 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
168 that if you must retry your request, the server will know to ignore the
169 request if it has already been completed.
170
171 For example, consider a situation where you make an initial request and
172 the request times out. If you make the request again with the same
173 request ID, the server can check if original operation with the same
174 request ID was received, and if so, will ignore the second request. This
175 prevents clients from accidentally creating duplicate commitments.
176
177 The request ID must be
178 a valid UUID with the exception that zero UUID is not supported
179 (00000000-0000-0000-0000-000000000000).
180 x__xgafv: string, V1 error format.
181 Allowed values
182 1 - v1 error format
183 2 - v2 error format
184
185 Returns:
186 An object of the form:
187
188 { # Represents an Operation resource.
189 #
190 # Google Compute Engine has three Operation resources:
191 #
192 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
193 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
194 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
195 #
196 # You can use an operation resource to manage asynchronous API requests.
197 # For more information, readHandling
198 # API responses.
199 #
200 # Operations can be global, regional or zonal.
201 #
202 # - For global operations, use the `globalOperations`
203 # resource.
204 # - For regional operations, use the
205 # `regionOperations` resource.
206 # - For zonal operations, use
207 # the `zoneOperations` resource.
208 #
209 #
210 #
211 # For more information, read
212 # Global, Regional, and Zonal Resources.
213 #
214 # Note that completed Operation resources have a limited
215 # retention period.
216 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
217 # Not present otherwise.
218 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
219 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
220 # set when the operation is created.
221 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
222 # text format.
223 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
224 # this field will be populated.
225 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
226 # operation.
227 {
228 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
229 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
230 # details. There is a set of defined message types to use for providing
231 # details.The syntax depends on the error code. For example,
232 # QuotaExceededInfo will have details when the error code is
233 # QUOTA_EXCEEDED.
234 {
235 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
236 #
237 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
238 # is not enabled:
239 #
240 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
241 # &quot;domain&quot;: &quot;googleapis.com&quot;
242 # &quot;metadata&quot;: {
243 # &quot;resource&quot;: &quot;projects/123&quot;,
244 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
245 # }
246 # }
247 #
248 # This response indicates that the pubsub.googleapis.com API is not enabled.
249 #
250 # Example of an error that is returned when attempting to create a Spanner
251 # instance in a region that is out of stock:
252 #
253 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
254 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
255 # &quot;metadata&quot;: {
256 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
257 # }
258 # }
259 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
260 # is typically the registered service name of the tool or product that
261 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
262 # generated by some common infrastructure, the error domain must be a
263 # globally unique value that identifies the infrastructure. For Google API
264 # infrastructure, the error domain is &quot;googleapis.com&quot;.
265 &quot;metadatas&quot;: { # Additional structured details about this error.
266 #
267 # Keys must match a regular expression of `a-z+` but should
268 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
269 # length. When identifying the current value of an exceeded limit, the units
270 # should be contained in the key, not the value. For example, rather than
271 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
272 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
273 # instances that can be created in a single (batch) request.
274 &quot;a_key&quot;: &quot;A String&quot;,
275 },
276 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
277 # proximate cause of the error. Error reasons are unique within a particular
278 # domain of errors. This should be at most 63 characters and match a
279 # regular expression of `A-Z+[A-Z0-9]`, which represents
280 # UPPER_SNAKE_CASE.
281 },
282 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
283 #
284 # For example, if a quota check failed with an error indicating the calling
285 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
286 # directly to the right place in the developer console to flip the bit.
287 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
288 { # Describes a URL link.
289 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
290 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
291 },
292 ],
293 },
294 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
295 # which can be attached to an RPC error.
296 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
297 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
298 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
299 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
300 },
301 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
302 &quot;dimensions&quot;: { # The map holding related quota dimensions.
303 &quot;a_key&quot;: &quot;A String&quot;,
304 },
305 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
306 # type or metric.
307 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
308 # or metric.
309 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
310 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
311 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
312 },
313 },
314 ],
315 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
316 # This property is optional.
317 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
318 },
319 ],
320 },
321 &quot;getVersionOperationMetadata&quot;: {
322 &quot;inlineSbomInfo&quot;: {
323 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
324 # appropriate identifiers.
325 &quot;a_key&quot;: &quot;A String&quot;,
326 },
327 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
328 # identifiers.
329 &quot;a_key&quot;: &quot;A String&quot;,
330 },
331 },
332 },
333 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
334 # message that was returned, such as `NOT FOUND`.
335 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
336 # status code that was returned. For example, a `404` means the
337 # resource was not found.
338 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
339 # defined by the server.
340 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
341 # This value is inRFC3339
342 # text format.
343 &quot;instancesBulkInsertOperationMetadata&quot;: {
344 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
345 # Example key: zones/us-central1-a
346 &quot;a_key&quot;: {
347 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
348 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
349 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
350 # error.
351 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
352 # if the flow is rolling forward or rolling back.
353 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
354 },
355 },
356 },
357 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
358 # Operation resources.
359 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
360 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
361 # group of operations results from a `bulkInsert` API request.
362 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
363 # `update`, or `delete`, and so on.
364 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
365 # There is no requirement that this be linear or support any granularity of
366 # operations. This should not be used to guess when the operation will be
367 # complete. This number should monotonically increase as the operation
368 # progresses.
369 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
370 # applicable when performing regional operations.
371 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
372 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
373 # this field will contain information on all underlying zonal actions and
374 # their state.
375 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
376 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
377 # Example key: zones/us-central1-a
378 &quot;a_key&quot;: {
379 &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
380 # populated.
381 # different programming environments, including REST APIs and RPC APIs. It is
382 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
383 # three pieces of data: error code, error message, and error details.
384 #
385 # You can find out more about this error model and how to work with it in the
386 # [API Design Guide](https://cloud.google.com/apis/design/errors).
387 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
388 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
389 # message types for APIs to use.
390 {
391 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
392 },
393 ],
394 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
395 # user-facing error message should be localized and sent in the
396 # google.rpc.Status.details field, or localized by the client.
397 },
398 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
399 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
400 },
401 },
402 },
403 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
404 # This value is inRFC3339
405 # text format.
406 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
407 # following:
408 # `PENDING`, `RUNNING`, or `DONE`.
409 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
410 # operation.
411 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
412 # of the target resource.
413 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
414 # operations related to creating a snapshot, this points to the disk
415 # that the snapshot was created from.
416 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
417 # `[email protected]` or
418 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
419 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
420 # operation, this field will be populated.
421 {
422 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
423 # Engine returns NO_RESULTS_ON_PAGE if there
424 # are no results in the response.
425 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
426 # value format. For example:
427 #
428 # &quot;data&quot;: [
429 # {
430 # &quot;key&quot;: &quot;scope&quot;,
431 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
432 # }
433 {
434 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
435 # returned. For example, for warnings where there are no results in a list
436 # request for a particular zone, this key might be scope and
437 # the key value might be the zone name. Other examples might be a key
438 # indicating a deprecated resource and a suggested replacement, or a
439 # warning about invalid network settings (for example, if an instance
440 # attempts to perform IP forwarding but is not enabled for IP forwarding).
441 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
442 },
443 ],
444 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
445 },
446 ],
447 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
448 # applicable when performing per-zone operations.
449 }</pre>
450 </div>
451
452 <div class="method">
453 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)</code>
454 <pre>Retrieves an aggregated list of persistent disks.
455
456 To prevent failure, it is recommended that you set the
457 `returnPartialSuccess` parameter to `true`.
458
459 Args:
460 project: string, Project ID for this request. (required)
461 filter: string, A filter expression that filters resources listed in the response. Most
462 Compute resources support two types of filter expressions:
463 expressions that support regular expressions and expressions that follow
464 API improvement proposal AIP-160.
465 These two types of filter expressions cannot be mixed in one request.
466
467 If you want to use AIP-160, your expression must specify the field name, an
468 operator, and the value that you want to use for filtering. The value
469 must be a string, a number, or a boolean. The operator
470 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
471
472 For example, if you are filtering Compute Engine instances, you can
473 exclude instances named `example-instance` by specifying
474 `name != example-instance`.
475
476 The `:*` comparison can be used to test whether a key has been defined.
477 For example, to find all objects with `owner` label use:
478 ```
479 labels.owner:*
480 ```
481
482 You can also filter nested fields. For example, you could specify
483 `scheduling.automaticRestart = false` to include instances only
484 if they are not scheduled for automatic restarts. You can use filtering
485 on nested fields to filter based onresource labels.
486
487 To filter on multiple expressions, provide each separate expression within
488 parentheses. For example:
489 ```
490 (scheduling.automaticRestart = true)
491 (cpuPlatform = &quot;Intel Skylake&quot;)
492 ```
493 By default, each expression is an `AND` expression. However, you
494 can include `AND` and `OR` expressions explicitly.
495 For example:
496 ```
497 (cpuPlatform = &quot;Intel Skylake&quot;) OR
498 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
499 (scheduling.automaticRestart = true)
500 ```
501
502 If you want to use a regular expression, use the `eq` (equal) or `ne`
503 (not equal) operator against a single un-parenthesized expression with or
504 without quotes or against multiple parenthesized expressions. Examples:
505
506 `fieldname eq unquoted literal`
507 `fieldname eq &#x27;single quoted literal&#x27;`
508 `fieldname eq &quot;double quoted literal&quot;`
509 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
510
511 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
512 The literal value must match the entire field.
513
514 For example, to filter for instances that do not end with name &quot;instance&quot;,
515 you would use `name ne .*instance`.
516
517 You cannot combine constraints on multiple fields using regular
518 expressions.
519 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
520 global) should be included in the response. For new resource types added
521 after this field, the flag has no effect as new resource types will always
522 include every visible scope for each scope type in response. For resource
523 types which predate this field, if this flag is omitted or false, only
524 scopes of the scope types where the resource type is expected to be found
525 will be included.
526 maxResults: integer, The maximum number of results per page that should be returned.
527 If the number of available results is larger than `maxResults`,
528 Compute Engine returns a `nextPageToken` that can be used to get
529 the next page of results in subsequent list requests. Acceptable values are
530 `0` to `500`, inclusive. (Default: `500`)
531 orderBy: string, Sorts list results by a certain order. By default, results
532 are returned in alphanumerical order based on the resource name.
533
534 You can also sort results in descending order based on the creation
535 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
536 results based on the `creationTimestamp` field in
537 reverse chronological order (newest result first). Use this to sort
538 resources like operations so that the newest operation is returned first.
539
540 Currently, only sorting by `name` or
541 `creationTimestamp desc` is supported.
542 pageToken: string, Specifies a page token to use. Set `pageToken` to the
543 `nextPageToken` returned by a previous list request to get
544 the next page of results.
545 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
546 of failure. The default value is false.
547
548 For example, when partial success behavior is enabled, aggregatedList for a
549 single zone scope either returns all resources in the zone or no resources,
550 with an error code.
551 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
552 aggregated list request is invoked for subnetworks list-usable api.
553 x__xgafv: string, V1 error format.
554 Allowed values
555 1 - v1 error format
556 2 - v2 error format
557
558 Returns:
559 An object of the form:
560
561 {
562 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
563 &quot;items&quot;: { # A list of DisksScopedList resources.
564 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of disks.
565 &quot;disks&quot;: [ # [Output Only] A list of disks contained in this scope.
566 { # Represents a Persistent Disk resource.
567 #
568 # Google Compute Engine has two Disk resources:
569 #
570 # * [Zonal](/compute/docs/reference/rest/beta/disks)
571 # * [Regional](/compute/docs/reference/rest/beta/regionDisks)
572 #
573 # Persistent disks are required for running your VM instances.
574 # Create both boot and non-boot (data) persistent disks. For more information,
575 # read Persistent Disks. For more
576 # storage options, read Storage options.
577 #
578 # The disks resource represents a zonal persistent disk.
579 # For more information, readZonal persistent disks.
580 #
581 # The regionDisks resource represents a
582 # regional persistent disk. For more information, read
583 # Regional resources.
584 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
585 #
586 #
587 # - READ_WRITE_SINGLE: The default AccessMode, means the
588 # disk can be attached to single instance in RW mode.
589 # - READ_WRITE_MANY: The AccessMode means the disk can be
590 # attached to multiple instances in RW mode.
591 # - READ_ONLY_MANY: The AccessMode means the disk can be
592 # attached to multiple instances in RO mode.
593 #
594 #
595 # The AccessMode is only valid for Hyperdisk disk types.
596 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
597 # ARM64 or X86_64.
598 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
599 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
600 # started on the disk as a member of a group.
601 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
602 # started on the disk as a member of a group.
603 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
604 # You can provide this as a partial or full URL to the resource.
605 # For example, the following are valid values:
606 #
607 #
608 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
609 # - projects/project/zones/zone/disks/disk
610 # - zones/zone/disks/disk
611 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
612 # to or from the current disk. This value identifies the exact disk that
613 # was used to create this replication. For example, if you started
614 # replicating the persistent disk from a disk that was later deleted and
615 # recreated under the same name, the disk ID would identify the exact
616 # version of the disk that was used.
617 },
618 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
619 &quot;a_key&quot;: {
620 &quot;asyncReplicationDisk&quot;: {
621 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
622 # started on the disk as a member of a group.
623 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
624 # started on the disk as a member of a group.
625 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
626 # You can provide this as a partial or full URL to the resource.
627 # For example, the following are valid values:
628 #
629 #
630 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
631 # - projects/project/zones/zone/disks/disk
632 # - zones/zone/disks/disk
633 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
634 # to or from the current disk. This value identifies the exact disk that
635 # was used to create this replication. For example, if you started
636 # replicating the persistent disk from a disk that was later deleted and
637 # recreated under the same name, the disk ID would identify the exact
638 # version of the disk that was used.
639 },
640 },
641 },
642 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
643 # text format.
644 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
645 # create the resource.
646 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
647 # customer-supplied encryption key or a
648 # customer-managed encryption key.
649 #
650 # Encryption keys do not protect access to metadata of the disk.
651 #
652 # After you encrypt a disk with a customer-supplied key, you must provide the
653 # same key if you use the disk later. For example, to create a disk snapshot,
654 # to create a disk image, to create a machine image, or to attach the disk to
655 # a virtual machine.
656 #
657 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
658 # name once the disk is created. The disk is encrypted with this version of
659 # the key. In the response, diskEncryptionKey.kmsKeyName appears
660 # in the following format:
661 #
662 # &quot;diskEncryptionKey.kmsKeyName&quot;:
663 # &quot;projects/kms_project_id/locations/region/keyRings/
664 # key_region/cryptoKeys/key
665 # /cryptoKeysVersions/version
666 #
667 # If you do not provide an encryption key when creating the disk, then the
668 # disk is encrypted using an automatically generated key and you don&#x27;t need
669 # to provide a key to use the disk later.
670 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
671 # For example:
672 #
673 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
674 # key_region/cryptoKeys/key
675 #
676 # The fully-qualifed key name may be returned for resource GET requests. For
677 # example:
678 #
679 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
680 # key_region/cryptoKeys/key
681 # /cryptoKeyVersions/1
682 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
683 # key. If absent, the Compute Engine default service account is used.
684 # For example:
685 #
686 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
687 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
688 # encryption key, encoded in RFC
689 # 4648 base64 to either encrypt or decrypt this resource. You can
690 # provide either the rawKey or thersaEncryptedKey.
691 # For example:
692 #
693 # &quot;rawKey&quot;:
694 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
695 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
696 # customer-supplied encryption key to either encrypt or decrypt this
697 # resource. You can provide either the rawKey or thersaEncryptedKey.
698 # For example:
699 #
700 # &quot;rsaEncryptedKey&quot;:
701 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
702 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
703 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
704 #
705 # The key must meet the following requirements before you can provide it to
706 # Compute Engine:
707 #
708 # 1. The key is wrapped using a RSA public key certificate provided by
709 # Google.
710 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
711 # encoding.
712 #
713 # Gets the RSA public key certificate provided by Google at:
714 #
715 #
716 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
717 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
718 # 4648 base64 encoded SHA-256 hash of the customer-supplied
719 # encryption key that protects this resource.
720 },
721 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
722 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disk restored from a source snapshot should erase
723 # Windows specific VSS signature.
724 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
725 # only for bootable images. Read
726 # Enabling guest operating system features to see a list of available
727 # options.
728 { # Guest OS features.
729 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
730 # separate values. Set to one or more of the following values:
731 #
732 # - VIRTIO_SCSI_MULTIQUEUE
733 # - WINDOWS
734 # - MULTI_IP_SUBNET
735 # - UEFI_COMPATIBLE
736 # - GVNIC
737 # - SEV_CAPABLE
738 # - SUSPEND_RESUME_COMPATIBLE
739 # - SEV_LIVE_MIGRATABLE_V2
740 # - SEV_SNP_CAPABLE
741 # - TDX_CAPABLE
742 # - IDPF
743 # - SNP_SVSM_CAPABLE
744 # - CCA_CAPABLE
745 #
746 #
747 # For more information, see
748 # Enabling guest operating system features.
749 },
750 ],
751 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
752 # defined by the server.
753 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
754 # which is either SCSI or NVME. The default isSCSI.
755 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
756 # disks.
757 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
758 # essentially a hash of the labels set used for optimistic locking. The
759 # fingerprint is initially generated by Compute Engine and changes after
760 # every request to modify or update labels. You must always provide an
761 # up-to-date fingerprint hash in order to update or change labels,
762 # otherwise the request will fail with error412 conditionNotMet.
763 #
764 # To see the latest fingerprint, make a get() request to
765 # retrieve a disk.
766 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
767 # the setLabels method.
768 &quot;a_key&quot;: &quot;A String&quot;,
769 },
770 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
771 # text format.
772 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
773 # text format.
774 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
775 &quot;A String&quot;,
776 ],
777 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
778 &quot;A String&quot;,
779 ],
780 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
781 # This field is for use by internal tools that use the public API.
782 &quot;locked&quot;: True or False, # Output only. [Output Only] The field indicates if the disk is created from a locked
783 # source image. Attachment of a disk created from a locked source image will
784 # cause the following operations to become irreversibly prohibited:
785 #
786 # - R/W or R/O disk attachment to any other instance
787 # - Disk detachment. And the disk can only be deleted when the instance
788 # is deleted
789 # - Creation of images or snapshots
790 # - Disk cloning
791 #
792 #
793 #
794 # Furthermore, the instance with at least one disk with locked flag set to
795 # true will be prohibited from performing the operations below:
796 #
797 # - Further attachment of secondary disks.
798 # - Detachment of any disks
799 # - Create machine images
800 # - Create instance template
801 # - Delete the instance with --keep-disk parameter set to true for locked
802 # disks
803 # - Attach a locked disk with --auto-delete parameter set to false
804 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
805 # more than one instance.
806 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
807 # The name must be 1-63 characters long, and comply withRFC1035.
808 # Specifically, the name must be 1-63 characters long and match the regular
809 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
810 # which means the first character must be a lowercase letter, and all
811 # following characters must be a dash, lowercase letter, or digit, except
812 # the last character, which cannot be a dash.
813 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
814 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
815 # as part of resource payload.
816 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
817 # have the same definition as resource
818 # manager tags. Keys and values can be either in numeric format,
819 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
820 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
821 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
822 # PATCH) when empty.
823 &quot;a_key&quot;: &quot;A String&quot;,
824 },
825 },
826 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
827 # If not present in a request, a default value is used.
828 # The currently supported size is 4096, other sizes may be added in
829 # the future.
830 # If an unsupported value is requested, the error message will list
831 # the supported values for the caller&#x27;s project.
832 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
833 # of I/O operations per second that the disk can handle. Values must be
834 # between 10,000 and 120,000. For more details, see theExtreme persistent
835 # disk documentation.
836 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
837 # number of throughput mb per second that the disk can handle. Values must be
838 # greater than or equal to 1.
839 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
840 # regional resources.
841 # You must specify this field as part of the HTTP request URL. It is
842 # not settable as a field in the request body.
843 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
844 # for regional resources.
845 &quot;A String&quot;,
846 ],
847 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
848 &quot;A String&quot;,
849 ],
850 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
851 &quot;asyncPrimaryDisk&quot;: {
852 &quot;state&quot;: &quot;A String&quot;,
853 },
854 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
855 &quot;a_key&quot;: {
856 &quot;state&quot;: &quot;A String&quot;,
857 },
858 },
859 },
860 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
861 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
862 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
863 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
864 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
865 # persistent disk.
866 #
867 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
868 # source.
869 # Acceptable values are greater than 0.
870 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
871 # that was created using a consistency group.
872 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
873 # that was created using a consistency group.
874 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
875 # partial or full URL to the resource. For example, the following are valid
876 # values:
877 #
878 #
879 # -
880 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
881 #
882 # -
883 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
884 #
885 # -
886 # projects/project/zones/zone/disks/disk
887 #
888 # -
889 # projects/project/regions/region/disks/disk
890 #
891 # -
892 # zones/zone/disks/disk
893 #
894 # -
895 # regions/region/disks/disk
896 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
897 # value identifies the exact disk that was used to create this persistent
898 # disk. For example, if you created the persistent disk from a disk that
899 # was later deleted and recreated under the same name, the source disk ID
900 # would identify the exact version of the disk that was used.
901 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
902 # deleted, this field will not be set.
903 #
904 # To create a disk with one of the public operating system images, specify
905 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
906 #
907 # projects/debian-cloud/global/images/family/debian-9
908 #
909 #
910 # Alternatively, use a specific version of a public operating system image:
911 #
912 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
913 #
914 #
915 # To create a disk with a custom image that you created, specify the
916 # image name in the following format:
917 #
918 # global/images/my-custom-image
919 #
920 #
921 # You can also specify a custom image by its image family, which returns
922 # the latest version of the image in that family. Replace the image name
923 # with family/family-name:
924 #
925 # global/images/family/my-image-family
926 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
927 # encryption key of the source image. Required if the source image is
928 # protected by a customer-supplied encryption key.
929 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
930 # For example:
931 #
932 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
933 # key_region/cryptoKeys/key
934 #
935 # The fully-qualifed key name may be returned for resource GET requests. For
936 # example:
937 #
938 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
939 # key_region/cryptoKeys/key
940 # /cryptoKeyVersions/1
941 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
942 # key. If absent, the Compute Engine default service account is used.
943 # For example:
944 #
945 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
946 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
947 # encryption key, encoded in RFC
948 # 4648 base64 to either encrypt or decrypt this resource. You can
949 # provide either the rawKey or thersaEncryptedKey.
950 # For example:
951 #
952 # &quot;rawKey&quot;:
953 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
954 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
955 # customer-supplied encryption key to either encrypt or decrypt this
956 # resource. You can provide either the rawKey or thersaEncryptedKey.
957 # For example:
958 #
959 # &quot;rsaEncryptedKey&quot;:
960 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
961 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
962 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
963 #
964 # The key must meet the following requirements before you can provide it to
965 # Compute Engine:
966 #
967 # 1. The key is wrapped using a RSA public key certificate provided by
968 # Google.
969 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
970 # encoding.
971 #
972 # Gets the RSA public key certificate provided by Google at:
973 #
974 #
975 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
976 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
977 # 4648 base64 encoded SHA-256 hash of the customer-supplied
978 # encryption key that protects this resource.
979 },
980 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
981 # value identifies the exact image that was used to create this persistent
982 # disk. For example, if you created the persistent disk from an image that
983 # was later deleted and recreated under the same name, the source image ID
984 # would identify the exact version of the image that was used.
985 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
986 # this as a partial or full URL to the resource. For example, the following
987 # are valid values:
988 #
989 #
990 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
991 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
992 # - zones/zone/instantSnapshots/instantSnapshot
993 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
994 # disk. This value identifies the exact instant snapshot that was used to
995 # create this persistent disk. For example, if you created the persistent
996 # disk from an instant snapshot that was later deleted and recreated under
997 # the same name, the source instant snapshot ID would identify the exact
998 # version of the instant snapshot that was used.
999 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # The machine image to create the disk from. You can provide this as a
1000 # partial or full URL to the resource. For example, the following are valid
1001 # values:
1002 #
1003 #
1004 # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage
1005 # - projects/project/global/machineImages/machineImage
1006 # - global/machineImages/machineImage
1007 &quot;sourceMachineImageDiskDeviceName&quot;: &quot;A String&quot;, # The device name of a disk within a given machine image. The
1008 # source_machine_image must be specified.
1009 &quot;sourceMachineImageEncryptionKey&quot;: { # Thecustomer-supplied
1010 # encryption key of the source machine image. Required if the source
1011 # machine image is protected by a customer-supplied encryption key.
1012 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1013 # For example:
1014 #
1015 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1016 # key_region/cryptoKeys/key
1017 #
1018 # The fully-qualifed key name may be returned for resource GET requests. For
1019 # example:
1020 #
1021 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1022 # key_region/cryptoKeys/key
1023 # /cryptoKeyVersions/1
1024 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1025 # key. If absent, the Compute Engine default service account is used.
1026 # For example:
1027 #
1028 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1029 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1030 # encryption key, encoded in RFC
1031 # 4648 base64 to either encrypt or decrypt this resource. You can
1032 # provide either the rawKey or thersaEncryptedKey.
1033 # For example:
1034 #
1035 # &quot;rawKey&quot;:
1036 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1037 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1038 # customer-supplied encryption key to either encrypt or decrypt this
1039 # resource. You can provide either the rawKey or thersaEncryptedKey.
1040 # For example:
1041 #
1042 # &quot;rsaEncryptedKey&quot;:
1043 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1044 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1045 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1046 #
1047 # The key must meet the following requirements before you can provide it to
1048 # Compute Engine:
1049 #
1050 # 1. The key is wrapped using a RSA public key certificate provided by
1051 # Google.
1052 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1053 # encoding.
1054 #
1055 # Gets the RSA public key certificate provided by Google at:
1056 #
1057 #
1058 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1059 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1060 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1061 # encryption key that protects this resource.
1062 },
1063 &quot;sourceMachineImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the machine image used to create this disk.
1064 # This value identifies the exact machine image that was used to create this
1065 # persistent disk. For example, if you created the persistent disk from a
1066 # machine image that was later deleted and recreated under the same name, the
1067 # source machine image ID would identify the exact version of the machine
1068 # image that was used.
1069 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
1070 # partial or full URL to the resource. For example, the following are valid
1071 # values:
1072 #
1073 #
1074 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
1075 # - projects/project/global/snapshots/snapshot
1076 # - global/snapshots/snapshot
1077 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
1078 # encryption key of the source snapshot. Required if the source snapshot
1079 # is protected by a customer-supplied encryption key.
1080 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1081 # For example:
1082 #
1083 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1084 # key_region/cryptoKeys/key
1085 #
1086 # The fully-qualifed key name may be returned for resource GET requests. For
1087 # example:
1088 #
1089 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1090 # key_region/cryptoKeys/key
1091 # /cryptoKeyVersions/1
1092 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1093 # key. If absent, the Compute Engine default service account is used.
1094 # For example:
1095 #
1096 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1097 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1098 # encryption key, encoded in RFC
1099 # 4648 base64 to either encrypt or decrypt this resource. You can
1100 # provide either the rawKey or thersaEncryptedKey.
1101 # For example:
1102 #
1103 # &quot;rawKey&quot;:
1104 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1105 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1106 # customer-supplied encryption key to either encrypt or decrypt this
1107 # resource. You can provide either the rawKey or thersaEncryptedKey.
1108 # For example:
1109 #
1110 # &quot;rsaEncryptedKey&quot;:
1111 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1112 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1113 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1114 #
1115 # The key must meet the following requirements before you can provide it to
1116 # Compute Engine:
1117 #
1118 # 1. The key is wrapped using a RSA public key certificate provided by
1119 # Google.
1120 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1121 # encoding.
1122 #
1123 # Gets the RSA public key certificate provided by Google at:
1124 #
1125 #
1126 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1127 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1128 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1129 # encryption key that protects this resource.
1130 },
1131 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
1132 # value identifies the exact snapshot that was used to create this persistent
1133 # disk. For example, if you created the persistent disk from a snapshot that
1134 # was later deleted and recreated under the same name, the source snapshot ID
1135 # would identify the exact version of the snapshot that was used.
1136 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
1137 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
1138 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
1139 # https://storage.googleapis.com/. This flag is not optimized for creating
1140 # multiple disks from a source storage object. To create many disks from a
1141 # source storage object, use gcloud compute images
1142 # import instead.
1143 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
1144 #
1145 #
1146 # - CREATING: Disk is provisioning.
1147 # - RESTORING: Source data is being copied into the
1148 # disk.
1149 # - FAILED: Disk creation failed.
1150 # - READY: Disk is ready for use.
1151 # - DELETING: Disk is deleting.
1152 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
1153 # this as a partial or full URL to the resource. For example, the following
1154 # are valid values:
1155 #
1156 #
1157 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
1158 # - projects/project/zones/zone/storagePools/storagePool
1159 # - zones/zone/storagePools/storagePool
1160 &quot;storageType&quot;: &quot;A String&quot;, # [Deprecated] Storage type of the persistent disk.
1161 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
1162 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
1163 # types.
1164 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
1165 # in form:projects/project/zones/zone/instances/instance
1166 &quot;A String&quot;,
1167 ],
1168 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
1169 # You must specify this field as part of the HTTP request URL. It is
1170 # not settable as a field in the request body.
1171 },
1172 ],
1173 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of disks when
1174 # the list is empty.
1175 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1176 # Engine returns NO_RESULTS_ON_PAGE if there
1177 # are no results in the response.
1178 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1179 # value format. For example:
1180 #
1181 # &quot;data&quot;: [
1182 # {
1183 # &quot;key&quot;: &quot;scope&quot;,
1184 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1185 # }
1186 {
1187 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1188 # returned. For example, for warnings where there are no results in a list
1189 # request for a particular zone, this key might be scope and
1190 # the key value might be the zone name. Other examples might be a key
1191 # indicating a deprecated resource and a suggested replacement, or a
1192 # warning about invalid network settings (for example, if an instance
1193 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1194 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1195 },
1196 ],
1197 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1198 },
1199 },
1200 },
1201 &quot;kind&quot;: &quot;compute#diskAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#diskAggregatedList for aggregated lists of persistent
1202 # disks.
1203 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1204 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1205 # the query parameter pageToken in the next list request.
1206 # Subsequent list requests will have their own nextPageToken to
1207 # continue paging through the results.
1208 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1209 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1210 &quot;A String&quot;,
1211 ],
1212 &quot;warning&quot;: { # [Output Only] Informational warning message.
1213 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1214 # Engine returns NO_RESULTS_ON_PAGE if there
1215 # are no results in the response.
1216 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1217 # value format. For example:
1218 #
1219 # &quot;data&quot;: [
1220 # {
1221 # &quot;key&quot;: &quot;scope&quot;,
1222 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1223 # }
1224 {
1225 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1226 # returned. For example, for warnings where there are no results in a list
1227 # request for a particular zone, this key might be scope and
1228 # the key value might be the zone name. Other examples might be a key
1229 # indicating a deprecated resource and a suggested replacement, or a
1230 # warning about invalid network settings (for example, if an instance
1231 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1232 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1233 },
1234 ],
1235 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1236 },
1237 }</pre>
1238 </div>
1239
1240 <div class="method">
1241 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1242 <pre>Retrieves the next page of results.
1243
1244 Args:
1245 previous_request: The request for the previous page. (required)
1246 previous_response: The response from the request for the previous page. (required)
1247
1248 Returns:
1249 A request object that you can call &#x27;execute()&#x27; on to request the next
1250 page. Returns None if there are no more items in the collection.
1251 </pre>
1252 </div>
1253
1254 <div class="method">
1255 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1256 <pre>Bulk create a set of disks.
1257
1258 Args:
1259 project: string, Project ID for this request. (required)
1260 zone: string, The name of the zone for this request. (required)
1261 body: object, The request body.
1262 The object takes the form of:
1263
1264 { # A transient resource used in compute.disks.bulkInsert and
1265 # compute.regionDisks.bulkInsert. It is only used to process
1266 # requests and is not persisted.
1267 &quot;instantSnapshotGroupParameters&quot;: { # The parameters for the instant snapshot group.
1268 &quot;sourceInstantSnapshotGroup&quot;: &quot;A String&quot;, # The source instant snapshot group used to create disks. You can provide
1269 # this as a partial or full URL to the resource. For example, the following
1270 # are valid values:
1271 #
1272 #
1273 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup
1274 # - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup
1275 # - zones/zone/instantSnapshotGroups/instantSnapshotGroup
1276 },
1277 &quot;snapshotGroupParameters&quot;: { # The parameters for the snapshot group. The usage of snapshot group feature
1278 # is restricted.
1279 &quot;replicaZones&quot;: [ # URLs of the zones where disks should be replicated to. Only applicable
1280 # for regional resources.
1281 &quot;A String&quot;,
1282 ],
1283 &quot;sourceSnapshotGroup&quot;: &quot;A String&quot;, # The source snapshot group used to create disks. You can provide this as a
1284 # partial or full URL to the resource. For example, the following are valid
1285 # values:
1286 #
1287 #
1288 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup
1289 # - projects/project/global/snapshotGroups/snapshotGroup
1290 # - global/snapshotGroups/snapshotGroup
1291 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
1292 # disks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
1293 # types.
1294 },
1295 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.
1296 # This may be a full or partial URL, such as:
1297 #
1298 #
1299 # -
1300 # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
1301 #
1302 # -
1303 # projects/project/regions/region/resourcePolicies/resourcePolicy
1304 #
1305 # -
1306 # regions/region/resourcePolicies/resourcePolicy
1307 }
1308
1309 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1310 that if you must retry your request, the server will know to ignore the
1311 request if it has already been completed.
1312
1313 For example, consider a situation where you make an initial request and
1314 the request times out. If you make the request again with the same
1315 request ID, the server can check if original operation with the same
1316 request ID was received, and if so, will ignore the second request. This
1317 prevents clients from accidentally creating duplicate commitments.
1318
1319 The request ID must be
1320 a valid UUID with the exception that zero UUID is not supported
1321 (00000000-0000-0000-0000-000000000000).
1322 x__xgafv: string, V1 error format.
1323 Allowed values
1324 1 - v1 error format
1325 2 - v2 error format
1326
1327 Returns:
1328 An object of the form:
1329
1330 { # Represents an Operation resource.
1331 #
1332 # Google Compute Engine has three Operation resources:
1333 #
1334 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1335 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1336 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1337 #
1338 # You can use an operation resource to manage asynchronous API requests.
1339 # For more information, readHandling
1340 # API responses.
1341 #
1342 # Operations can be global, regional or zonal.
1343 #
1344 # - For global operations, use the `globalOperations`
1345 # resource.
1346 # - For regional operations, use the
1347 # `regionOperations` resource.
1348 # - For zonal operations, use
1349 # the `zoneOperations` resource.
1350 #
1351 #
1352 #
1353 # For more information, read
1354 # Global, Regional, and Zonal Resources.
1355 #
1356 # Note that completed Operation resources have a limited
1357 # retention period.
1358 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1359 # Not present otherwise.
1360 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1361 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1362 # set when the operation is created.
1363 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1364 # text format.
1365 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1366 # this field will be populated.
1367 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1368 # operation.
1369 {
1370 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1371 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1372 # details. There is a set of defined message types to use for providing
1373 # details.The syntax depends on the error code. For example,
1374 # QuotaExceededInfo will have details when the error code is
1375 # QUOTA_EXCEEDED.
1376 {
1377 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1378 #
1379 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1380 # is not enabled:
1381 #
1382 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1383 # &quot;domain&quot;: &quot;googleapis.com&quot;
1384 # &quot;metadata&quot;: {
1385 # &quot;resource&quot;: &quot;projects/123&quot;,
1386 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1387 # }
1388 # }
1389 #
1390 # This response indicates that the pubsub.googleapis.com API is not enabled.
1391 #
1392 # Example of an error that is returned when attempting to create a Spanner
1393 # instance in a region that is out of stock:
1394 #
1395 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1396 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1397 # &quot;metadata&quot;: {
1398 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1399 # }
1400 # }
1401 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1402 # is typically the registered service name of the tool or product that
1403 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1404 # generated by some common infrastructure, the error domain must be a
1405 # globally unique value that identifies the infrastructure. For Google API
1406 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1407 &quot;metadatas&quot;: { # Additional structured details about this error.
1408 #
1409 # Keys must match a regular expression of `a-z+` but should
1410 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1411 # length. When identifying the current value of an exceeded limit, the units
1412 # should be contained in the key, not the value. For example, rather than
1413 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1414 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1415 # instances that can be created in a single (batch) request.
1416 &quot;a_key&quot;: &quot;A String&quot;,
1417 },
1418 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1419 # proximate cause of the error. Error reasons are unique within a particular
1420 # domain of errors. This should be at most 63 characters and match a
1421 # regular expression of `A-Z+[A-Z0-9]`, which represents
1422 # UPPER_SNAKE_CASE.
1423 },
1424 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1425 #
1426 # For example, if a quota check failed with an error indicating the calling
1427 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1428 # directly to the right place in the developer console to flip the bit.
1429 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1430 { # Describes a URL link.
1431 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1432 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1433 },
1434 ],
1435 },
1436 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1437 # which can be attached to an RPC error.
1438 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1439 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1440 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1441 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1442 },
1443 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1444 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1445 &quot;a_key&quot;: &quot;A String&quot;,
1446 },
1447 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1448 # type or metric.
1449 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1450 # or metric.
1451 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1452 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1453 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1454 },
1455 },
1456 ],
1457 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1458 # This property is optional.
1459 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1460 },
1461 ],
1462 },
1463 &quot;getVersionOperationMetadata&quot;: {
1464 &quot;inlineSbomInfo&quot;: {
1465 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1466 # appropriate identifiers.
1467 &quot;a_key&quot;: &quot;A String&quot;,
1468 },
1469 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1470 # identifiers.
1471 &quot;a_key&quot;: &quot;A String&quot;,
1472 },
1473 },
1474 },
1475 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1476 # message that was returned, such as `NOT FOUND`.
1477 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1478 # status code that was returned. For example, a `404` means the
1479 # resource was not found.
1480 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1481 # defined by the server.
1482 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1483 # This value is inRFC3339
1484 # text format.
1485 &quot;instancesBulkInsertOperationMetadata&quot;: {
1486 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1487 # Example key: zones/us-central1-a
1488 &quot;a_key&quot;: {
1489 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1490 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1491 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1492 # error.
1493 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1494 # if the flow is rolling forward or rolling back.
1495 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1496 },
1497 },
1498 },
1499 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1500 # Operation resources.
1501 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1502 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1503 # group of operations results from a `bulkInsert` API request.
1504 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1505 # `update`, or `delete`, and so on.
1506 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1507 # There is no requirement that this be linear or support any granularity of
1508 # operations. This should not be used to guess when the operation will be
1509 # complete. This number should monotonically increase as the operation
1510 # progresses.
1511 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1512 # applicable when performing regional operations.
1513 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1514 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1515 # this field will contain information on all underlying zonal actions and
1516 # their state.
1517 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1518 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1519 # Example key: zones/us-central1-a
1520 &quot;a_key&quot;: {
1521 &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
1522 # populated.
1523 # different programming environments, including REST APIs and RPC APIs. It is
1524 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1525 # three pieces of data: error code, error message, and error details.
1526 #
1527 # You can find out more about this error model and how to work with it in the
1528 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1529 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1530 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1531 # message types for APIs to use.
1532 {
1533 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1534 },
1535 ],
1536 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1537 # user-facing error message should be localized and sent in the
1538 # google.rpc.Status.details field, or localized by the client.
1539 },
1540 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1541 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1542 },
1543 },
1544 },
1545 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1546 # This value is inRFC3339
1547 # text format.
1548 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1549 # following:
1550 # `PENDING`, `RUNNING`, or `DONE`.
1551 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1552 # operation.
1553 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1554 # of the target resource.
1555 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1556 # operations related to creating a snapshot, this points to the disk
1557 # that the snapshot was created from.
1558 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1559 # `[email protected]` or
1560 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1561 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1562 # operation, this field will be populated.
1563 {
1564 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1565 # Engine returns NO_RESULTS_ON_PAGE if there
1566 # are no results in the response.
1567 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1568 # value format. For example:
1569 #
1570 # &quot;data&quot;: [
1571 # {
1572 # &quot;key&quot;: &quot;scope&quot;,
1573 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1574 # }
1575 {
1576 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1577 # returned. For example, for warnings where there are no results in a list
1578 # request for a particular zone, this key might be scope and
1579 # the key value might be the zone name. Other examples might be a key
1580 # indicating a deprecated resource and a suggested replacement, or a
1581 # warning about invalid network settings (for example, if an instance
1582 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1583 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1584 },
1585 ],
1586 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1587 },
1588 ],
1589 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1590 # applicable when performing per-zone operations.
1591 }</pre>
1592 </div>
1593
1594 <div class="method">
1595 <code class="details" id="bulkSetLabels">bulkSetLabels(project, zone, body=None, requestId=None, resource=None, x__xgafv=None)</code>
1596 <pre>Sets the labels on many disks at once. To learn more about labels, read theLabeling
1597 Resources documentation.
1598
1599 Args:
1600 project: string, Project ID for this request. (required)
1601 zone: string, The name of the zone for this request. (required)
1602 body: object, The request body.
1603 The object takes the form of:
1604
1605 {
1606 &quot;requests&quot;: [
1607 {
1608 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
1609 # used to detect conflicts. The fingerprint is initially generated by Compute
1610 # Engine and changes after every request to modify or update labels. You may
1611 # optionally provide an up-to-date fingerprint hash in order to update or
1612 # change labels. Make a get() request to the resource to get the
1613 # latest fingerprint.
1614 &quot;labels&quot;: { # The labels to set for this resource.
1615 &quot;a_key&quot;: &quot;A String&quot;,
1616 },
1617 },
1618 ],
1619 }
1620
1621 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1622 that if you must retry your request, the server will know to ignore the
1623 request if it has already been completed.
1624
1625 For example, consider a situation where you make an initial request and
1626 the request times out. If you make the request again with the same
1627 request ID, the server can check if original operation with the same
1628 request ID was received, and if so, will ignore the second request. This
1629 prevents clients from accidentally creating duplicate commitments.
1630
1631 The request ID must be
1632 a valid UUID with the exception that zero UUID is not supported
1633 (00000000-0000-0000-0000-000000000000).
1634 resource: string, Name or id of the resource for this request.
1635 x__xgafv: string, V1 error format.
1636 Allowed values
1637 1 - v1 error format
1638 2 - v2 error format
1639
1640 Returns:
1641 An object of the form:
1642
1643 { # Represents an Operation resource.
1644 #
1645 # Google Compute Engine has three Operation resources:
1646 #
1647 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
1648 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
1649 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
1650 #
1651 # You can use an operation resource to manage asynchronous API requests.
1652 # For more information, readHandling
1653 # API responses.
1654 #
1655 # Operations can be global, regional or zonal.
1656 #
1657 # - For global operations, use the `globalOperations`
1658 # resource.
1659 # - For regional operations, use the
1660 # `regionOperations` resource.
1661 # - For zonal operations, use
1662 # the `zoneOperations` resource.
1663 #
1664 #
1665 #
1666 # For more information, read
1667 # Global, Regional, and Zonal Resources.
1668 #
1669 # Note that completed Operation resources have a limited
1670 # retention period.
1671 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1672 # Not present otherwise.
1673 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1674 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1675 # set when the operation is created.
1676 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1677 # text format.
1678 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1679 # this field will be populated.
1680 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1681 # operation.
1682 {
1683 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1684 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1685 # details. There is a set of defined message types to use for providing
1686 # details.The syntax depends on the error code. For example,
1687 # QuotaExceededInfo will have details when the error code is
1688 # QUOTA_EXCEEDED.
1689 {
1690 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1691 #
1692 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1693 # is not enabled:
1694 #
1695 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1696 # &quot;domain&quot;: &quot;googleapis.com&quot;
1697 # &quot;metadata&quot;: {
1698 # &quot;resource&quot;: &quot;projects/123&quot;,
1699 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1700 # }
1701 # }
1702 #
1703 # This response indicates that the pubsub.googleapis.com API is not enabled.
1704 #
1705 # Example of an error that is returned when attempting to create a Spanner
1706 # instance in a region that is out of stock:
1707 #
1708 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1709 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1710 # &quot;metadata&quot;: {
1711 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1712 # }
1713 # }
1714 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1715 # is typically the registered service name of the tool or product that
1716 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1717 # generated by some common infrastructure, the error domain must be a
1718 # globally unique value that identifies the infrastructure. For Google API
1719 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1720 &quot;metadatas&quot;: { # Additional structured details about this error.
1721 #
1722 # Keys must match a regular expression of `a-z+` but should
1723 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1724 # length. When identifying the current value of an exceeded limit, the units
1725 # should be contained in the key, not the value. For example, rather than
1726 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1727 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1728 # instances that can be created in a single (batch) request.
1729 &quot;a_key&quot;: &quot;A String&quot;,
1730 },
1731 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1732 # proximate cause of the error. Error reasons are unique within a particular
1733 # domain of errors. This should be at most 63 characters and match a
1734 # regular expression of `A-Z+[A-Z0-9]`, which represents
1735 # UPPER_SNAKE_CASE.
1736 },
1737 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1738 #
1739 # For example, if a quota check failed with an error indicating the calling
1740 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1741 # directly to the right place in the developer console to flip the bit.
1742 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1743 { # Describes a URL link.
1744 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1745 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1746 },
1747 ],
1748 },
1749 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1750 # which can be attached to an RPC error.
1751 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1752 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1753 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1754 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1755 },
1756 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1757 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1758 &quot;a_key&quot;: &quot;A String&quot;,
1759 },
1760 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1761 # type or metric.
1762 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1763 # or metric.
1764 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1765 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1766 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1767 },
1768 },
1769 ],
1770 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1771 # This property is optional.
1772 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1773 },
1774 ],
1775 },
1776 &quot;getVersionOperationMetadata&quot;: {
1777 &quot;inlineSbomInfo&quot;: {
1778 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1779 # appropriate identifiers.
1780 &quot;a_key&quot;: &quot;A String&quot;,
1781 },
1782 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1783 # identifiers.
1784 &quot;a_key&quot;: &quot;A String&quot;,
1785 },
1786 },
1787 },
1788 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1789 # message that was returned, such as `NOT FOUND`.
1790 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1791 # status code that was returned. For example, a `404` means the
1792 # resource was not found.
1793 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1794 # defined by the server.
1795 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1796 # This value is inRFC3339
1797 # text format.
1798 &quot;instancesBulkInsertOperationMetadata&quot;: {
1799 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1800 # Example key: zones/us-central1-a
1801 &quot;a_key&quot;: {
1802 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1803 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1804 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1805 # error.
1806 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1807 # if the flow is rolling forward or rolling back.
1808 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1809 },
1810 },
1811 },
1812 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1813 # Operation resources.
1814 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1815 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1816 # group of operations results from a `bulkInsert` API request.
1817 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1818 # `update`, or `delete`, and so on.
1819 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1820 # There is no requirement that this be linear or support any granularity of
1821 # operations. This should not be used to guess when the operation will be
1822 # complete. This number should monotonically increase as the operation
1823 # progresses.
1824 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1825 # applicable when performing regional operations.
1826 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1827 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1828 # this field will contain information on all underlying zonal actions and
1829 # their state.
1830 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1831 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1832 # Example key: zones/us-central1-a
1833 &quot;a_key&quot;: {
1834 &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
1835 # populated.
1836 # different programming environments, including REST APIs and RPC APIs. It is
1837 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1838 # three pieces of data: error code, error message, and error details.
1839 #
1840 # You can find out more about this error model and how to work with it in the
1841 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1842 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1843 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1844 # message types for APIs to use.
1845 {
1846 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1847 },
1848 ],
1849 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1850 # user-facing error message should be localized and sent in the
1851 # google.rpc.Status.details field, or localized by the client.
1852 },
1853 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1854 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1855 },
1856 },
1857 },
1858 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1859 # This value is inRFC3339
1860 # text format.
1861 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1862 # following:
1863 # `PENDING`, `RUNNING`, or `DONE`.
1864 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1865 # operation.
1866 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1867 # of the target resource.
1868 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1869 # operations related to creating a snapshot, this points to the disk
1870 # that the snapshot was created from.
1871 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1872 # `[email protected]` or
1873 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1874 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1875 # operation, this field will be populated.
1876 {
1877 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1878 # Engine returns NO_RESULTS_ON_PAGE if there
1879 # are no results in the response.
1880 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1881 # value format. For example:
1882 #
1883 # &quot;data&quot;: [
1884 # {
1885 # &quot;key&quot;: &quot;scope&quot;,
1886 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1887 # }
1888 {
1889 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1890 # returned. For example, for warnings where there are no results in a list
1891 # request for a particular zone, this key might be scope and
1892 # the key value might be the zone name. Other examples might be a key
1893 # indicating a deprecated resource and a suggested replacement, or a
1894 # warning about invalid network settings (for example, if an instance
1895 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1896 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1897 },
1898 ],
1899 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1900 },
1901 ],
1902 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1903 # applicable when performing per-zone operations.
1904 }</pre>
1905 </div>
1906
1907 <div class="method">
1908 <code class="details" id="close">close()</code>
1909 <pre>Close httplib2 connections.</pre>
1910 </div>
1911
1912 <div class="method">
1913 <code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</code>
1914 <pre>Creates a snapshot of a specified persistent disk. For regular snapshot
1915 creation, consider using snapshots.insert
1916 instead, as that method supports more features, such as creating snapshots
1917 in a project different from the source disk project.
1918
1919 Args:
1920 project: string, Project ID for this request. (required)
1921 zone: string, The name of the zone for this request. (required)
1922 disk: string, Name of the persistent disk to snapshot. (required)
1923 body: object, The request body.
1924 The object takes the form of:
1925
1926 { # Represents a Persistent Disk Snapshot resource.
1927 #
1928 # You can use snapshots to back up data on a regular interval. For more
1929 # information, read Creating
1930 # persistent disk snapshots.
1931 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1932 # ARM64 or X86_64.
1933 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1934 # applying resource policy on the target disk.
1935 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1936 # specified name. The chain name must be 1-63 characters long and comply
1937 # with RFC1035. This is an uncommon option only for advanced service
1938 # owners who needs to create separate snapshot chains, for example,
1939 # for chargeback tracking. When you describe your snapshot resource, this
1940 # field is visible only if it has a non-empty value.
1941 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1942 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1943 # text format.
1944 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1945 # create the resource.
1946 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1947 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1948 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1949 # [Output Only]: This field is not set by user, but from source disk.
1950 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
1951 # informing the OS to prepare for the snapshot process.
1952 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1953 # Applicable only for bootable images. Read
1954 # Enabling guest operating system features to see a list of available
1955 # options.
1956 { # Guest OS features.
1957 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1958 # separate values. Set to one or more of the following values:
1959 #
1960 # - VIRTIO_SCSI_MULTIQUEUE
1961 # - WINDOWS
1962 # - MULTI_IP_SUBNET
1963 # - UEFI_COMPATIBLE
1964 # - GVNIC
1965 # - SEV_CAPABLE
1966 # - SUSPEND_RESUME_COMPATIBLE
1967 # - SEV_LIVE_MIGRATABLE_V2
1968 # - SEV_SNP_CAPABLE
1969 # - TDX_CAPABLE
1970 # - IDPF
1971 # - SNP_SVSM_CAPABLE
1972 # - CCA_CAPABLE
1973 #
1974 #
1975 # For more information, see
1976 # Enabling guest operating system features.
1977 },
1978 ],
1979 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1980 # defined by the server.
1981 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1982 # for Snapshot resources.
1983 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1984 # essentially a hash of the labels set used for optimistic locking. The
1985 # fingerprint is initially generated by Compute Engine and changes after
1986 # every request to modify or update labels. You must always provide an
1987 # up-to-date fingerprint hash in order to update or change labels,
1988 # otherwise the request will fail with error412 conditionNotMet.
1989 #
1990 # To see the latest fingerprint, make a get() request to
1991 # retrieve a snapshot.
1992 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1993 # the setLabels method.
1994 # Label values may be empty.
1995 &quot;a_key&quot;: &quot;A String&quot;,
1996 },
1997 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1998 # to this snapshot.
1999 &quot;A String&quot;,
2000 ],
2001 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
2002 # snapshot. This can be because the original image had licenses attached
2003 # (such as a Windows image).
2004 &quot;A String&quot;,
2005 ],
2006 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
2007 # resources.
2008 # This field is for use by internal tools that use the public API.
2009 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2010 # The name must be 1-63 characters long, and comply withRFC1035.
2011 # Specifically, the name must be 1-63 characters long and match the regular
2012 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2013 # character must be a lowercase letter, and all following characters must be
2014 # a dash, lowercase letter, or digit, except the last character, which cannot
2015 # be a dash.
2016 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2017 # as part of resource payload.
2018 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
2019 # the same definition as resource
2020 # manager tags. Keys and values can be either in numeric format,
2021 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2022 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2023 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2024 # PATCH) when empty.
2025 &quot;a_key&quot;: &quot;A String&quot;,
2026 },
2027 },
2028 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
2029 # for regional snapshots.
2030 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2031 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2032 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2033 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
2034 # encryption key.
2035 #
2036 # After you encrypt a snapshot using a customer-supplied key, you must
2037 # provide the same key if you use the snapshot later. For example, you must
2038 # provide the encryption key when you create a disk from the encrypted
2039 # snapshot in a future request.
2040 #
2041 # Customer-supplied encryption keys do not protect access to metadata
2042 # of the snapshot.
2043 #
2044 # If you do not provide an encryption key when creating the snapshot, then
2045 # the snapshot will be encrypted using an automatically generated key and you
2046 # do not need to provide a key to use the snapshot later.
2047 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2048 # For example:
2049 #
2050 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2051 # key_region/cryptoKeys/key
2052 #
2053 # The fully-qualifed key name may be returned for resource GET requests. For
2054 # example:
2055 #
2056 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2057 # key_region/cryptoKeys/key
2058 # /cryptoKeyVersions/1
2059 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2060 # key. If absent, the Compute Engine default service account is used.
2061 # For example:
2062 #
2063 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2064 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2065 # encryption key, encoded in RFC
2066 # 4648 base64 to either encrypt or decrypt this resource. You can
2067 # provide either the rawKey or thersaEncryptedKey.
2068 # For example:
2069 #
2070 # &quot;rawKey&quot;:
2071 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2072 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2073 # customer-supplied encryption key to either encrypt or decrypt this
2074 # resource. You can provide either the rawKey or thersaEncryptedKey.
2075 # For example:
2076 #
2077 # &quot;rsaEncryptedKey&quot;:
2078 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2079 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2080 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2081 #
2082 # The key must meet the following requirements before you can provide it to
2083 # Compute Engine:
2084 #
2085 # 1. The key is wrapped using a RSA public key certificate provided by
2086 # Google.
2087 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2088 # encoding.
2089 #
2090 # Gets the RSA public key certificate provided by Google at:
2091 #
2092 #
2093 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2094 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2095 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2096 # encryption key that protects this resource.
2097 },
2098 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
2099 # belongs to. The usage of snapshot group feature is restricted.
2100 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
2101 # of snapshot group feature is restricted.
2102 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
2103 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
2104 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
2105 # encryption key of the source disk. Required if the source disk is
2106 # protected by a customer-supplied encryption key.
2107 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2108 # For example:
2109 #
2110 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2111 # key_region/cryptoKeys/key
2112 #
2113 # The fully-qualifed key name may be returned for resource GET requests. For
2114 # example:
2115 #
2116 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2117 # key_region/cryptoKeys/key
2118 # /cryptoKeyVersions/1
2119 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2120 # key. If absent, the Compute Engine default service account is used.
2121 # For example:
2122 #
2123 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2124 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2125 # encryption key, encoded in RFC
2126 # 4648 base64 to either encrypt or decrypt this resource. You can
2127 # provide either the rawKey or thersaEncryptedKey.
2128 # For example:
2129 #
2130 # &quot;rawKey&quot;:
2131 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2132 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2133 # customer-supplied encryption key to either encrypt or decrypt this
2134 # resource. You can provide either the rawKey or thersaEncryptedKey.
2135 # For example:
2136 #
2137 # &quot;rsaEncryptedKey&quot;:
2138 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2139 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2140 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2141 #
2142 # The key must meet the following requirements before you can provide it to
2143 # Compute Engine:
2144 #
2145 # 1. The key is wrapped using a RSA public key certificate provided by
2146 # Google.
2147 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2148 # encoding.
2149 #
2150 # Gets the RSA public key certificate provided by Google at:
2151 #
2152 #
2153 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2154 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2155 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2156 # encryption key that protects this resource.
2157 },
2158 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
2159 # snapshot.
2160 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
2161 # value may be used to determine whether the snapshot was taken from the
2162 # current or a previous instance of a given disk name.
2163 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
2164 # this as a partial or full URL to the resource. For example, the following
2165 # are valid values:
2166 #
2167 #
2168 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
2169 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
2170 # - zones/zone/instantSnapshots/instantSnapshot
2171 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
2172 # Snapshot.
2173 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2174 # For example:
2175 #
2176 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2177 # key_region/cryptoKeys/key
2178 #
2179 # The fully-qualifed key name may be returned for resource GET requests. For
2180 # example:
2181 #
2182 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2183 # key_region/cryptoKeys/key
2184 # /cryptoKeyVersions/1
2185 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2186 # key. If absent, the Compute Engine default service account is used.
2187 # For example:
2188 #
2189 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2190 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2191 # encryption key, encoded in RFC
2192 # 4648 base64 to either encrypt or decrypt this resource. You can
2193 # provide either the rawKey or thersaEncryptedKey.
2194 # For example:
2195 #
2196 # &quot;rawKey&quot;:
2197 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2198 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2199 # customer-supplied encryption key to either encrypt or decrypt this
2200 # resource. You can provide either the rawKey or thersaEncryptedKey.
2201 # For example:
2202 #
2203 # &quot;rsaEncryptedKey&quot;:
2204 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2205 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2206 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2207 #
2208 # The key must meet the following requirements before you can provide it to
2209 # Compute Engine:
2210 #
2211 # 1. The key is wrapped using a RSA public key certificate provided by
2212 # Google.
2213 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2214 # encoding.
2215 #
2216 # Gets the RSA public key certificate provided by Google at:
2217 #
2218 #
2219 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2220 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2221 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2222 # encryption key that protects this resource.
2223 },
2224 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
2225 # snapshot. This value identifies the exact instant snapshot that was used to
2226 # create this snapshot. For example, if you created the snapshot from an
2227 # instant snapshot that was later deleted and recreated under the same name,
2228 # the source instant snapshot ID would identify the exact instant snapshot
2229 # that was used.
2230 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
2231 # scheduled snapshot.
2232 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
2233 # scheduled snapshot.
2234 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
2235 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
2236 # share storage, this number is expected to change with snapshot
2237 # creation/deletion.
2238 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
2239 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
2240 # [Output Only] An indicator whether storageBytes is in a
2241 # stable state or it is being adjusted as a result of shared storage
2242 # reallocation. This status can either be unset, meaning the snapshot is
2243 # being created, or UP_TO_DATE, meaning the size of the snapshot
2244 # is up-to-date.
2245 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
2246 # multi-regional).
2247 &quot;A String&quot;,
2248 ],
2249 }
2250
2251 guestFlush: boolean, [Input Only] Whether to attempt an application consistent snapshot by
2252 informing the OS to prepare for the snapshot process.
2253 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2254 that if you must retry your request, the server will know to ignore the
2255 request if it has already been completed.
2256
2257 For example, consider a situation where you make an initial request and
2258 the request times out. If you make the request again with the same
2259 request ID, the server can check if original operation with the same
2260 request ID was received, and if so, will ignore the second request. This
2261 prevents clients from accidentally creating duplicate commitments.
2262
2263 The request ID must be
2264 a valid UUID with the exception that zero UUID is not supported
2265 (00000000-0000-0000-0000-000000000000).
2266 x__xgafv: string, V1 error format.
2267 Allowed values
2268 1 - v1 error format
2269 2 - v2 error format
2270
2271 Returns:
2272 An object of the form:
2273
2274 { # Represents an Operation resource.
2275 #
2276 # Google Compute Engine has three Operation resources:
2277 #
2278 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2279 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2280 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2281 #
2282 # You can use an operation resource to manage asynchronous API requests.
2283 # For more information, readHandling
2284 # API responses.
2285 #
2286 # Operations can be global, regional or zonal.
2287 #
2288 # - For global operations, use the `globalOperations`
2289 # resource.
2290 # - For regional operations, use the
2291 # `regionOperations` resource.
2292 # - For zonal operations, use
2293 # the `zoneOperations` resource.
2294 #
2295 #
2296 #
2297 # For more information, read
2298 # Global, Regional, and Zonal Resources.
2299 #
2300 # Note that completed Operation resources have a limited
2301 # retention period.
2302 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2303 # Not present otherwise.
2304 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2305 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2306 # set when the operation is created.
2307 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2308 # text format.
2309 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2310 # this field will be populated.
2311 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2312 # operation.
2313 {
2314 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2315 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2316 # details. There is a set of defined message types to use for providing
2317 # details.The syntax depends on the error code. For example,
2318 # QuotaExceededInfo will have details when the error code is
2319 # QUOTA_EXCEEDED.
2320 {
2321 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2322 #
2323 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2324 # is not enabled:
2325 #
2326 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2327 # &quot;domain&quot;: &quot;googleapis.com&quot;
2328 # &quot;metadata&quot;: {
2329 # &quot;resource&quot;: &quot;projects/123&quot;,
2330 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2331 # }
2332 # }
2333 #
2334 # This response indicates that the pubsub.googleapis.com API is not enabled.
2335 #
2336 # Example of an error that is returned when attempting to create a Spanner
2337 # instance in a region that is out of stock:
2338 #
2339 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2340 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2341 # &quot;metadata&quot;: {
2342 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2343 # }
2344 # }
2345 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2346 # is typically the registered service name of the tool or product that
2347 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2348 # generated by some common infrastructure, the error domain must be a
2349 # globally unique value that identifies the infrastructure. For Google API
2350 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2351 &quot;metadatas&quot;: { # Additional structured details about this error.
2352 #
2353 # Keys must match a regular expression of `a-z+` but should
2354 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2355 # length. When identifying the current value of an exceeded limit, the units
2356 # should be contained in the key, not the value. For example, rather than
2357 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2358 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2359 # instances that can be created in a single (batch) request.
2360 &quot;a_key&quot;: &quot;A String&quot;,
2361 },
2362 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2363 # proximate cause of the error. Error reasons are unique within a particular
2364 # domain of errors. This should be at most 63 characters and match a
2365 # regular expression of `A-Z+[A-Z0-9]`, which represents
2366 # UPPER_SNAKE_CASE.
2367 },
2368 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2369 #
2370 # For example, if a quota check failed with an error indicating the calling
2371 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2372 # directly to the right place in the developer console to flip the bit.
2373 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2374 { # Describes a URL link.
2375 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2376 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2377 },
2378 ],
2379 },
2380 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2381 # which can be attached to an RPC error.
2382 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2383 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2384 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2385 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2386 },
2387 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2388 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2389 &quot;a_key&quot;: &quot;A String&quot;,
2390 },
2391 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2392 # type or metric.
2393 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2394 # or metric.
2395 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2396 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2397 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2398 },
2399 },
2400 ],
2401 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2402 # This property is optional.
2403 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2404 },
2405 ],
2406 },
2407 &quot;getVersionOperationMetadata&quot;: {
2408 &quot;inlineSbomInfo&quot;: {
2409 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2410 # appropriate identifiers.
2411 &quot;a_key&quot;: &quot;A String&quot;,
2412 },
2413 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2414 # identifiers.
2415 &quot;a_key&quot;: &quot;A String&quot;,
2416 },
2417 },
2418 },
2419 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2420 # message that was returned, such as `NOT FOUND`.
2421 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2422 # status code that was returned. For example, a `404` means the
2423 # resource was not found.
2424 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2425 # defined by the server.
2426 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2427 # This value is inRFC3339
2428 # text format.
2429 &quot;instancesBulkInsertOperationMetadata&quot;: {
2430 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2431 # Example key: zones/us-central1-a
2432 &quot;a_key&quot;: {
2433 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2434 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2435 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2436 # error.
2437 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2438 # if the flow is rolling forward or rolling back.
2439 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2440 },
2441 },
2442 },
2443 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2444 # Operation resources.
2445 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2446 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2447 # group of operations results from a `bulkInsert` API request.
2448 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2449 # `update`, or `delete`, and so on.
2450 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2451 # There is no requirement that this be linear or support any granularity of
2452 # operations. This should not be used to guess when the operation will be
2453 # complete. This number should monotonically increase as the operation
2454 # progresses.
2455 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2456 # applicable when performing regional operations.
2457 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2458 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2459 # this field will contain information on all underlying zonal actions and
2460 # their state.
2461 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2462 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2463 # Example key: zones/us-central1-a
2464 &quot;a_key&quot;: {
2465 &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
2466 # populated.
2467 # different programming environments, including REST APIs and RPC APIs. It is
2468 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2469 # three pieces of data: error code, error message, and error details.
2470 #
2471 # You can find out more about this error model and how to work with it in the
2472 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2473 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2474 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2475 # message types for APIs to use.
2476 {
2477 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2478 },
2479 ],
2480 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2481 # user-facing error message should be localized and sent in the
2482 # google.rpc.Status.details field, or localized by the client.
2483 },
2484 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2485 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2486 },
2487 },
2488 },
2489 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2490 # This value is inRFC3339
2491 # text format.
2492 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2493 # following:
2494 # `PENDING`, `RUNNING`, or `DONE`.
2495 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2496 # operation.
2497 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2498 # of the target resource.
2499 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2500 # operations related to creating a snapshot, this points to the disk
2501 # that the snapshot was created from.
2502 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2503 # `[email protected]` or
2504 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2505 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2506 # operation, this field will be populated.
2507 {
2508 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2509 # Engine returns NO_RESULTS_ON_PAGE if there
2510 # are no results in the response.
2511 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2512 # value format. For example:
2513 #
2514 # &quot;data&quot;: [
2515 # {
2516 # &quot;key&quot;: &quot;scope&quot;,
2517 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2518 # }
2519 {
2520 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2521 # returned. For example, for warnings where there are no results in a list
2522 # request for a particular zone, this key might be scope and
2523 # the key value might be the zone name. Other examples might be a key
2524 # indicating a deprecated resource and a suggested replacement, or a
2525 # warning about invalid network settings (for example, if an instance
2526 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2527 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2528 },
2529 ],
2530 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2531 },
2532 ],
2533 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2534 # applicable when performing per-zone operations.
2535 }</pre>
2536 </div>
2537
2538 <div class="method">
2539 <code class="details" id="delete">delete(project, zone, disk, requestId=None, x__xgafv=None)</code>
2540 <pre>Deletes the specified persistent disk. Deleting a disk removes its data
2541 permanently and is irreversible. However, deleting a disk does not
2542 delete any snapshots
2543 previously made from the disk. You must separatelydelete
2544 snapshots.
2545
2546 Args:
2547 project: string, Project ID for this request. (required)
2548 zone: string, The name of the zone for this request. (required)
2549 disk: string, Name of the persistent disk to delete. (required)
2550 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2551 that if you must retry your request, the server will know to ignore the
2552 request if it has already been completed.
2553
2554 For example, consider a situation where you make an initial request and
2555 the request times out. If you make the request again with the same
2556 request ID, the server can check if original operation with the same
2557 request ID was received, and if so, will ignore the second request. This
2558 prevents clients from accidentally creating duplicate commitments.
2559
2560 The request ID must be
2561 a valid UUID with the exception that zero UUID is not supported
2562 (00000000-0000-0000-0000-000000000000).
2563 x__xgafv: string, V1 error format.
2564 Allowed values
2565 1 - v1 error format
2566 2 - v2 error format
2567
2568 Returns:
2569 An object of the form:
2570
2571 { # Represents an Operation resource.
2572 #
2573 # Google Compute Engine has three Operation resources:
2574 #
2575 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
2576 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
2577 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
2578 #
2579 # You can use an operation resource to manage asynchronous API requests.
2580 # For more information, readHandling
2581 # API responses.
2582 #
2583 # Operations can be global, regional or zonal.
2584 #
2585 # - For global operations, use the `globalOperations`
2586 # resource.
2587 # - For regional operations, use the
2588 # `regionOperations` resource.
2589 # - For zonal operations, use
2590 # the `zoneOperations` resource.
2591 #
2592 #
2593 #
2594 # For more information, read
2595 # Global, Regional, and Zonal Resources.
2596 #
2597 # Note that completed Operation resources have a limited
2598 # retention period.
2599 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2600 # Not present otherwise.
2601 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2602 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2603 # set when the operation is created.
2604 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2605 # text format.
2606 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2607 # this field will be populated.
2608 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2609 # operation.
2610 {
2611 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2612 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2613 # details. There is a set of defined message types to use for providing
2614 # details.The syntax depends on the error code. For example,
2615 # QuotaExceededInfo will have details when the error code is
2616 # QUOTA_EXCEEDED.
2617 {
2618 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2619 #
2620 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2621 # is not enabled:
2622 #
2623 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2624 # &quot;domain&quot;: &quot;googleapis.com&quot;
2625 # &quot;metadata&quot;: {
2626 # &quot;resource&quot;: &quot;projects/123&quot;,
2627 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2628 # }
2629 # }
2630 #
2631 # This response indicates that the pubsub.googleapis.com API is not enabled.
2632 #
2633 # Example of an error that is returned when attempting to create a Spanner
2634 # instance in a region that is out of stock:
2635 #
2636 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2637 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2638 # &quot;metadata&quot;: {
2639 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2640 # }
2641 # }
2642 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2643 # is typically the registered service name of the tool or product that
2644 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2645 # generated by some common infrastructure, the error domain must be a
2646 # globally unique value that identifies the infrastructure. For Google API
2647 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2648 &quot;metadatas&quot;: { # Additional structured details about this error.
2649 #
2650 # Keys must match a regular expression of `a-z+` but should
2651 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2652 # length. When identifying the current value of an exceeded limit, the units
2653 # should be contained in the key, not the value. For example, rather than
2654 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2655 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2656 # instances that can be created in a single (batch) request.
2657 &quot;a_key&quot;: &quot;A String&quot;,
2658 },
2659 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2660 # proximate cause of the error. Error reasons are unique within a particular
2661 # domain of errors. This should be at most 63 characters and match a
2662 # regular expression of `A-Z+[A-Z0-9]`, which represents
2663 # UPPER_SNAKE_CASE.
2664 },
2665 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2666 #
2667 # For example, if a quota check failed with an error indicating the calling
2668 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2669 # directly to the right place in the developer console to flip the bit.
2670 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2671 { # Describes a URL link.
2672 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2673 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2674 },
2675 ],
2676 },
2677 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2678 # which can be attached to an RPC error.
2679 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2680 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2681 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2682 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2683 },
2684 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2685 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2686 &quot;a_key&quot;: &quot;A String&quot;,
2687 },
2688 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2689 # type or metric.
2690 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2691 # or metric.
2692 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2693 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2694 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2695 },
2696 },
2697 ],
2698 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2699 # This property is optional.
2700 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2701 },
2702 ],
2703 },
2704 &quot;getVersionOperationMetadata&quot;: {
2705 &quot;inlineSbomInfo&quot;: {
2706 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2707 # appropriate identifiers.
2708 &quot;a_key&quot;: &quot;A String&quot;,
2709 },
2710 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2711 # identifiers.
2712 &quot;a_key&quot;: &quot;A String&quot;,
2713 },
2714 },
2715 },
2716 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2717 # message that was returned, such as `NOT FOUND`.
2718 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2719 # status code that was returned. For example, a `404` means the
2720 # resource was not found.
2721 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2722 # defined by the server.
2723 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2724 # This value is inRFC3339
2725 # text format.
2726 &quot;instancesBulkInsertOperationMetadata&quot;: {
2727 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2728 # Example key: zones/us-central1-a
2729 &quot;a_key&quot;: {
2730 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2731 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2732 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2733 # error.
2734 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2735 # if the flow is rolling forward or rolling back.
2736 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2737 },
2738 },
2739 },
2740 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2741 # Operation resources.
2742 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2743 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2744 # group of operations results from a `bulkInsert` API request.
2745 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2746 # `update`, or `delete`, and so on.
2747 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2748 # There is no requirement that this be linear or support any granularity of
2749 # operations. This should not be used to guess when the operation will be
2750 # complete. This number should monotonically increase as the operation
2751 # progresses.
2752 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2753 # applicable when performing regional operations.
2754 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2755 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2756 # this field will contain information on all underlying zonal actions and
2757 # their state.
2758 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2759 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2760 # Example key: zones/us-central1-a
2761 &quot;a_key&quot;: {
2762 &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
2763 # populated.
2764 # different programming environments, including REST APIs and RPC APIs. It is
2765 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2766 # three pieces of data: error code, error message, and error details.
2767 #
2768 # You can find out more about this error model and how to work with it in the
2769 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2770 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2771 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2772 # message types for APIs to use.
2773 {
2774 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2775 },
2776 ],
2777 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2778 # user-facing error message should be localized and sent in the
2779 # google.rpc.Status.details field, or localized by the client.
2780 },
2781 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2782 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2783 },
2784 },
2785 },
2786 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2787 # This value is inRFC3339
2788 # text format.
2789 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2790 # following:
2791 # `PENDING`, `RUNNING`, or `DONE`.
2792 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2793 # operation.
2794 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2795 # of the target resource.
2796 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2797 # operations related to creating a snapshot, this points to the disk
2798 # that the snapshot was created from.
2799 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2800 # `[email protected]` or
2801 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2802 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2803 # operation, this field will be populated.
2804 {
2805 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2806 # Engine returns NO_RESULTS_ON_PAGE if there
2807 # are no results in the response.
2808 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2809 # value format. For example:
2810 #
2811 # &quot;data&quot;: [
2812 # {
2813 # &quot;key&quot;: &quot;scope&quot;,
2814 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2815 # }
2816 {
2817 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2818 # returned. For example, for warnings where there are no results in a list
2819 # request for a particular zone, this key might be scope and
2820 # the key value might be the zone name. Other examples might be a key
2821 # indicating a deprecated resource and a suggested replacement, or a
2822 # warning about invalid network settings (for example, if an instance
2823 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2824 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2825 },
2826 ],
2827 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2828 },
2829 ],
2830 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2831 # applicable when performing per-zone operations.
2832 }</pre>
2833 </div>
2834
2835 <div class="method">
2836 <code class="details" id="get">get(project, zone, disk, x__xgafv=None)</code>
2837 <pre>Returns the specified persistent disk.
2838
2839 Args:
2840 project: string, Project ID for this request. (required)
2841 zone: string, The name of the zone for this request. (required)
2842 disk: string, Name of the persistent disk to return. (required)
2843 x__xgafv: string, V1 error format.
2844 Allowed values
2845 1 - v1 error format
2846 2 - v2 error format
2847
2848 Returns:
2849 An object of the form:
2850
2851 { # Represents a Persistent Disk resource.
2852 #
2853 # Google Compute Engine has two Disk resources:
2854 #
2855 # * [Zonal](/compute/docs/reference/rest/beta/disks)
2856 # * [Regional](/compute/docs/reference/rest/beta/regionDisks)
2857 #
2858 # Persistent disks are required for running your VM instances.
2859 # Create both boot and non-boot (data) persistent disks. For more information,
2860 # read Persistent Disks. For more
2861 # storage options, read Storage options.
2862 #
2863 # The disks resource represents a zonal persistent disk.
2864 # For more information, readZonal persistent disks.
2865 #
2866 # The regionDisks resource represents a
2867 # regional persistent disk. For more information, read
2868 # Regional resources.
2869 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
2870 #
2871 #
2872 # - READ_WRITE_SINGLE: The default AccessMode, means the
2873 # disk can be attached to single instance in RW mode.
2874 # - READ_WRITE_MANY: The AccessMode means the disk can be
2875 # attached to multiple instances in RW mode.
2876 # - READ_ONLY_MANY: The AccessMode means the disk can be
2877 # attached to multiple instances in RO mode.
2878 #
2879 #
2880 # The AccessMode is only valid for Hyperdisk disk types.
2881 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
2882 # ARM64 or X86_64.
2883 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
2884 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
2885 # started on the disk as a member of a group.
2886 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
2887 # started on the disk as a member of a group.
2888 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
2889 # You can provide this as a partial or full URL to the resource.
2890 # For example, the following are valid values:
2891 #
2892 #
2893 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
2894 # - projects/project/zones/zone/disks/disk
2895 # - zones/zone/disks/disk
2896 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
2897 # to or from the current disk. This value identifies the exact disk that
2898 # was used to create this replication. For example, if you started
2899 # replicating the persistent disk from a disk that was later deleted and
2900 # recreated under the same name, the disk ID would identify the exact
2901 # version of the disk that was used.
2902 },
2903 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
2904 &quot;a_key&quot;: {
2905 &quot;asyncReplicationDisk&quot;: {
2906 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
2907 # started on the disk as a member of a group.
2908 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
2909 # started on the disk as a member of a group.
2910 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
2911 # You can provide this as a partial or full URL to the resource.
2912 # For example, the following are valid values:
2913 #
2914 #
2915 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
2916 # - projects/project/zones/zone/disks/disk
2917 # - zones/zone/disks/disk
2918 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
2919 # to or from the current disk. This value identifies the exact disk that
2920 # was used to create this replication. For example, if you started
2921 # replicating the persistent disk from a disk that was later deleted and
2922 # recreated under the same name, the disk ID would identify the exact
2923 # version of the disk that was used.
2924 },
2925 },
2926 },
2927 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2928 # text format.
2929 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2930 # create the resource.
2931 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
2932 # customer-supplied encryption key or a
2933 # customer-managed encryption key.
2934 #
2935 # Encryption keys do not protect access to metadata of the disk.
2936 #
2937 # After you encrypt a disk with a customer-supplied key, you must provide the
2938 # same key if you use the disk later. For example, to create a disk snapshot,
2939 # to create a disk image, to create a machine image, or to attach the disk to
2940 # a virtual machine.
2941 #
2942 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
2943 # name once the disk is created. The disk is encrypted with this version of
2944 # the key. In the response, diskEncryptionKey.kmsKeyName appears
2945 # in the following format:
2946 #
2947 # &quot;diskEncryptionKey.kmsKeyName&quot;:
2948 # &quot;projects/kms_project_id/locations/region/keyRings/
2949 # key_region/cryptoKeys/key
2950 # /cryptoKeysVersions/version
2951 #
2952 # If you do not provide an encryption key when creating the disk, then the
2953 # disk is encrypted using an automatically generated key and you don&#x27;t need
2954 # to provide a key to use the disk later.
2955 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2956 # For example:
2957 #
2958 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2959 # key_region/cryptoKeys/key
2960 #
2961 # The fully-qualifed key name may be returned for resource GET requests. For
2962 # example:
2963 #
2964 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2965 # key_region/cryptoKeys/key
2966 # /cryptoKeyVersions/1
2967 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2968 # key. If absent, the Compute Engine default service account is used.
2969 # For example:
2970 #
2971 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2972 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2973 # encryption key, encoded in RFC
2974 # 4648 base64 to either encrypt or decrypt this resource. You can
2975 # provide either the rawKey or thersaEncryptedKey.
2976 # For example:
2977 #
2978 # &quot;rawKey&quot;:
2979 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2980 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2981 # customer-supplied encryption key to either encrypt or decrypt this
2982 # resource. You can provide either the rawKey or thersaEncryptedKey.
2983 # For example:
2984 #
2985 # &quot;rsaEncryptedKey&quot;:
2986 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2987 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2988 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2989 #
2990 # The key must meet the following requirements before you can provide it to
2991 # Compute Engine:
2992 #
2993 # 1. The key is wrapped using a RSA public key certificate provided by
2994 # Google.
2995 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2996 # encoding.
2997 #
2998 # Gets the RSA public key certificate provided by Google at:
2999 #
3000 #
3001 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3002 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3003 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3004 # encryption key that protects this resource.
3005 },
3006 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3007 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disk restored from a source snapshot should erase
3008 # Windows specific VSS signature.
3009 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3010 # only for bootable images. Read
3011 # Enabling guest operating system features to see a list of available
3012 # options.
3013 { # Guest OS features.
3014 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3015 # separate values. Set to one or more of the following values:
3016 #
3017 # - VIRTIO_SCSI_MULTIQUEUE
3018 # - WINDOWS
3019 # - MULTI_IP_SUBNET
3020 # - UEFI_COMPATIBLE
3021 # - GVNIC
3022 # - SEV_CAPABLE
3023 # - SUSPEND_RESUME_COMPATIBLE
3024 # - SEV_LIVE_MIGRATABLE_V2
3025 # - SEV_SNP_CAPABLE
3026 # - TDX_CAPABLE
3027 # - IDPF
3028 # - SNP_SVSM_CAPABLE
3029 # - CCA_CAPABLE
3030 #
3031 #
3032 # For more information, see
3033 # Enabling guest operating system features.
3034 },
3035 ],
3036 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3037 # defined by the server.
3038 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
3039 # which is either SCSI or NVME. The default isSCSI.
3040 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
3041 # disks.
3042 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
3043 # essentially a hash of the labels set used for optimistic locking. The
3044 # fingerprint is initially generated by Compute Engine and changes after
3045 # every request to modify or update labels. You must always provide an
3046 # up-to-date fingerprint hash in order to update or change labels,
3047 # otherwise the request will fail with error412 conditionNotMet.
3048 #
3049 # To see the latest fingerprint, make a get() request to
3050 # retrieve a disk.
3051 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
3052 # the setLabels method.
3053 &quot;a_key&quot;: &quot;A String&quot;,
3054 },
3055 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
3056 # text format.
3057 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
3058 # text format.
3059 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
3060 &quot;A String&quot;,
3061 ],
3062 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3063 &quot;A String&quot;,
3064 ],
3065 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
3066 # This field is for use by internal tools that use the public API.
3067 &quot;locked&quot;: True or False, # Output only. [Output Only] The field indicates if the disk is created from a locked
3068 # source image. Attachment of a disk created from a locked source image will
3069 # cause the following operations to become irreversibly prohibited:
3070 #
3071 # - R/W or R/O disk attachment to any other instance
3072 # - Disk detachment. And the disk can only be deleted when the instance
3073 # is deleted
3074 # - Creation of images or snapshots
3075 # - Disk cloning
3076 #
3077 #
3078 #
3079 # Furthermore, the instance with at least one disk with locked flag set to
3080 # true will be prohibited from performing the operations below:
3081 #
3082 # - Further attachment of secondary disks.
3083 # - Detachment of any disks
3084 # - Create machine images
3085 # - Create instance template
3086 # - Delete the instance with --keep-disk parameter set to true for locked
3087 # disks
3088 # - Attach a locked disk with --auto-delete parameter set to false
3089 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
3090 # more than one instance.
3091 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3092 # The name must be 1-63 characters long, and comply withRFC1035.
3093 # Specifically, the name must be 1-63 characters long and match the regular
3094 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
3095 # which means the first character must be a lowercase letter, and all
3096 # following characters must be a dash, lowercase letter, or digit, except
3097 # the last character, which cannot be a dash.
3098 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
3099 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
3100 # as part of resource payload.
3101 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3102 # have the same definition as resource
3103 # manager tags. Keys and values can be either in numeric format,
3104 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3105 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3106 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3107 # PATCH) when empty.
3108 &quot;a_key&quot;: &quot;A String&quot;,
3109 },
3110 },
3111 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
3112 # If not present in a request, a default value is used.
3113 # The currently supported size is 4096, other sizes may be added in
3114 # the future.
3115 # If an unsupported value is requested, the error message will list
3116 # the supported values for the caller&#x27;s project.
3117 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3118 # of I/O operations per second that the disk can handle. Values must be
3119 # between 10,000 and 120,000. For more details, see theExtreme persistent
3120 # disk documentation.
3121 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3122 # number of throughput mb per second that the disk can handle. Values must be
3123 # greater than or equal to 1.
3124 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
3125 # regional resources.
3126 # You must specify this field as part of the HTTP request URL. It is
3127 # not settable as a field in the request body.
3128 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
3129 # for regional resources.
3130 &quot;A String&quot;,
3131 ],
3132 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3133 &quot;A String&quot;,
3134 ],
3135 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
3136 &quot;asyncPrimaryDisk&quot;: {
3137 &quot;state&quot;: &quot;A String&quot;,
3138 },
3139 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
3140 &quot;a_key&quot;: {
3141 &quot;state&quot;: &quot;A String&quot;,
3142 },
3143 },
3144 },
3145 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3146 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
3147 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
3148 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
3149 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
3150 # persistent disk.
3151 #
3152 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
3153 # source.
3154 # Acceptable values are greater than 0.
3155 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
3156 # that was created using a consistency group.
3157 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
3158 # that was created using a consistency group.
3159 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
3160 # partial or full URL to the resource. For example, the following are valid
3161 # values:
3162 #
3163 #
3164 # -
3165 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3166 #
3167 # -
3168 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
3169 #
3170 # -
3171 # projects/project/zones/zone/disks/disk
3172 #
3173 # -
3174 # projects/project/regions/region/disks/disk
3175 #
3176 # -
3177 # zones/zone/disks/disk
3178 #
3179 # -
3180 # regions/region/disks/disk
3181 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
3182 # value identifies the exact disk that was used to create this persistent
3183 # disk. For example, if you created the persistent disk from a disk that
3184 # was later deleted and recreated under the same name, the source disk ID
3185 # would identify the exact version of the disk that was used.
3186 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
3187 # deleted, this field will not be set.
3188 #
3189 # To create a disk with one of the public operating system images, specify
3190 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3191 #
3192 # projects/debian-cloud/global/images/family/debian-9
3193 #
3194 #
3195 # Alternatively, use a specific version of a public operating system image:
3196 #
3197 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3198 #
3199 #
3200 # To create a disk with a custom image that you created, specify the
3201 # image name in the following format:
3202 #
3203 # global/images/my-custom-image
3204 #
3205 #
3206 # You can also specify a custom image by its image family, which returns
3207 # the latest version of the image in that family. Replace the image name
3208 # with family/family-name:
3209 #
3210 # global/images/family/my-image-family
3211 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3212 # encryption key of the source image. Required if the source image is
3213 # protected by a customer-supplied encryption key.
3214 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3215 # For example:
3216 #
3217 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3218 # key_region/cryptoKeys/key
3219 #
3220 # The fully-qualifed key name may be returned for resource GET requests. For
3221 # example:
3222 #
3223 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3224 # key_region/cryptoKeys/key
3225 # /cryptoKeyVersions/1
3226 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3227 # key. If absent, the Compute Engine default service account is used.
3228 # For example:
3229 #
3230 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3231 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3232 # encryption key, encoded in RFC
3233 # 4648 base64 to either encrypt or decrypt this resource. You can
3234 # provide either the rawKey or thersaEncryptedKey.
3235 # For example:
3236 #
3237 # &quot;rawKey&quot;:
3238 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3239 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3240 # customer-supplied encryption key to either encrypt or decrypt this
3241 # resource. You can provide either the rawKey or thersaEncryptedKey.
3242 # For example:
3243 #
3244 # &quot;rsaEncryptedKey&quot;:
3245 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3246 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3247 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3248 #
3249 # The key must meet the following requirements before you can provide it to
3250 # Compute Engine:
3251 #
3252 # 1. The key is wrapped using a RSA public key certificate provided by
3253 # Google.
3254 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3255 # encoding.
3256 #
3257 # Gets the RSA public key certificate provided by Google at:
3258 #
3259 #
3260 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3261 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3262 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3263 # encryption key that protects this resource.
3264 },
3265 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
3266 # value identifies the exact image that was used to create this persistent
3267 # disk. For example, if you created the persistent disk from an image that
3268 # was later deleted and recreated under the same name, the source image ID
3269 # would identify the exact version of the image that was used.
3270 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
3271 # this as a partial or full URL to the resource. For example, the following
3272 # are valid values:
3273 #
3274 #
3275 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
3276 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
3277 # - zones/zone/instantSnapshots/instantSnapshot
3278 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
3279 # disk. This value identifies the exact instant snapshot that was used to
3280 # create this persistent disk. For example, if you created the persistent
3281 # disk from an instant snapshot that was later deleted and recreated under
3282 # the same name, the source instant snapshot ID would identify the exact
3283 # version of the instant snapshot that was used.
3284 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # The machine image to create the disk from. You can provide this as a
3285 # partial or full URL to the resource. For example, the following are valid
3286 # values:
3287 #
3288 #
3289 # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage
3290 # - projects/project/global/machineImages/machineImage
3291 # - global/machineImages/machineImage
3292 &quot;sourceMachineImageDiskDeviceName&quot;: &quot;A String&quot;, # The device name of a disk within a given machine image. The
3293 # source_machine_image must be specified.
3294 &quot;sourceMachineImageEncryptionKey&quot;: { # Thecustomer-supplied
3295 # encryption key of the source machine image. Required if the source
3296 # machine image is protected by a customer-supplied encryption key.
3297 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3298 # For example:
3299 #
3300 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3301 # key_region/cryptoKeys/key
3302 #
3303 # The fully-qualifed key name may be returned for resource GET requests. For
3304 # example:
3305 #
3306 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3307 # key_region/cryptoKeys/key
3308 # /cryptoKeyVersions/1
3309 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3310 # key. If absent, the Compute Engine default service account is used.
3311 # For example:
3312 #
3313 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3314 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3315 # encryption key, encoded in RFC
3316 # 4648 base64 to either encrypt or decrypt this resource. You can
3317 # provide either the rawKey or thersaEncryptedKey.
3318 # For example:
3319 #
3320 # &quot;rawKey&quot;:
3321 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3322 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3323 # customer-supplied encryption key to either encrypt or decrypt this
3324 # resource. You can provide either the rawKey or thersaEncryptedKey.
3325 # For example:
3326 #
3327 # &quot;rsaEncryptedKey&quot;:
3328 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3329 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3330 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3331 #
3332 # The key must meet the following requirements before you can provide it to
3333 # Compute Engine:
3334 #
3335 # 1. The key is wrapped using a RSA public key certificate provided by
3336 # Google.
3337 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3338 # encoding.
3339 #
3340 # Gets the RSA public key certificate provided by Google at:
3341 #
3342 #
3343 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3344 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3345 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3346 # encryption key that protects this resource.
3347 },
3348 &quot;sourceMachineImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the machine image used to create this disk.
3349 # This value identifies the exact machine image that was used to create this
3350 # persistent disk. For example, if you created the persistent disk from a
3351 # machine image that was later deleted and recreated under the same name, the
3352 # source machine image ID would identify the exact version of the machine
3353 # image that was used.
3354 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
3355 # partial or full URL to the resource. For example, the following are valid
3356 # values:
3357 #
3358 #
3359 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
3360 # - projects/project/global/snapshots/snapshot
3361 # - global/snapshots/snapshot
3362 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3363 # encryption key of the source snapshot. Required if the source snapshot
3364 # is protected by a customer-supplied encryption key.
3365 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3366 # For example:
3367 #
3368 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3369 # key_region/cryptoKeys/key
3370 #
3371 # The fully-qualifed key name may be returned for resource GET requests. For
3372 # example:
3373 #
3374 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3375 # key_region/cryptoKeys/key
3376 # /cryptoKeyVersions/1
3377 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3378 # key. If absent, the Compute Engine default service account is used.
3379 # For example:
3380 #
3381 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3382 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3383 # encryption key, encoded in RFC
3384 # 4648 base64 to either encrypt or decrypt this resource. You can
3385 # provide either the rawKey or thersaEncryptedKey.
3386 # For example:
3387 #
3388 # &quot;rawKey&quot;:
3389 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3390 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3391 # customer-supplied encryption key to either encrypt or decrypt this
3392 # resource. You can provide either the rawKey or thersaEncryptedKey.
3393 # For example:
3394 #
3395 # &quot;rsaEncryptedKey&quot;:
3396 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3397 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3398 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3399 #
3400 # The key must meet the following requirements before you can provide it to
3401 # Compute Engine:
3402 #
3403 # 1. The key is wrapped using a RSA public key certificate provided by
3404 # Google.
3405 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3406 # encoding.
3407 #
3408 # Gets the RSA public key certificate provided by Google at:
3409 #
3410 #
3411 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3412 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3413 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3414 # encryption key that protects this resource.
3415 },
3416 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
3417 # value identifies the exact snapshot that was used to create this persistent
3418 # disk. For example, if you created the persistent disk from a snapshot that
3419 # was later deleted and recreated under the same name, the source snapshot ID
3420 # would identify the exact version of the snapshot that was used.
3421 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
3422 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
3423 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
3424 # https://storage.googleapis.com/. This flag is not optimized for creating
3425 # multiple disks from a source storage object. To create many disks from a
3426 # source storage object, use gcloud compute images
3427 # import instead.
3428 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
3429 #
3430 #
3431 # - CREATING: Disk is provisioning.
3432 # - RESTORING: Source data is being copied into the
3433 # disk.
3434 # - FAILED: Disk creation failed.
3435 # - READY: Disk is ready for use.
3436 # - DELETING: Disk is deleting.
3437 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3438 # this as a partial or full URL to the resource. For example, the following
3439 # are valid values:
3440 #
3441 #
3442 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3443 # - projects/project/zones/zone/storagePools/storagePool
3444 # - zones/zone/storagePools/storagePool
3445 &quot;storageType&quot;: &quot;A String&quot;, # [Deprecated] Storage type of the persistent disk.
3446 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
3447 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
3448 # types.
3449 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
3450 # in form:projects/project/zones/zone/instances/instance
3451 &quot;A String&quot;,
3452 ],
3453 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
3454 # You must specify this field as part of the HTTP request URL. It is
3455 # not settable as a field in the request body.
3456 }</pre>
3457 </div>
3458
3459 <div class="method">
3460 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
3461 <pre>Gets the access control policy for a resource. May be empty if no such
3462 policy or resource exists.
3463
3464 Args:
3465 project: string, Project ID for this request. (required)
3466 zone: string, The name of the zone for this request. (required)
3467 resource: string, Name or id of the resource for this request. (required)
3468 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
3469 x__xgafv: string, V1 error format.
3470 Allowed values
3471 1 - v1 error format
3472 2 - v2 error format
3473
3474 Returns:
3475 An object of the form:
3476
3477 { # An Identity and Access Management (IAM) policy, which specifies access
3478 # controls for Google Cloud resources.
3479 #
3480 #
3481 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3482 # `members`, or principals, to a single `role`. Principals can be user
3483 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3484 # `role` is a named list of permissions; each `role` can be an IAM predefined
3485 # role or a user-created custom role.
3486 #
3487 # For some types of Google Cloud resources, a `binding` can also specify a
3488 # `condition`, which is a logical expression that allows access to a resource
3489 # only if the expression evaluates to `true`. A condition can add constraints
3490 # based on attributes of the request, the resource, or both. To learn which
3491 # resources support conditions in their IAM policies, see the
3492 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3493 #
3494 # **JSON example:**
3495 #
3496 # ```
3497 # {
3498 # &quot;bindings&quot;: [
3499 # {
3500 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3501 # &quot;members&quot;: [
3502 # &quot;user:[email protected]&quot;,
3503 # &quot;group:[email protected]&quot;,
3504 # &quot;domain:google.com&quot;,
3505 # &quot;serviceAccount:[email protected]&quot;
3506 # ]
3507 # },
3508 # {
3509 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3510 # &quot;members&quot;: [
3511 # &quot;user:[email protected]&quot;
3512 # ],
3513 # &quot;condition&quot;: {
3514 # &quot;title&quot;: &quot;expirable access&quot;,
3515 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3516 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3517 # }
3518 # }
3519 # ],
3520 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3521 # &quot;version&quot;: 3
3522 # }
3523 # ```
3524 #
3525 # **YAML example:**
3526 #
3527 # ```
3528 # bindings:
3529 # - members:
3530 # - user:[email protected]
3531 # - group:[email protected]
3532 # - domain:google.com
3533 # - serviceAccount:[email protected]
3534 # role: roles/resourcemanager.organizationAdmin
3535 # - members:
3536 # - user:[email protected]
3537 # role: roles/resourcemanager.organizationViewer
3538 # condition:
3539 # title: expirable access
3540 # description: Does not grant access after Sep 2020
3541 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3542 # etag: BwWWja0YfJA=
3543 # version: 3
3544 # ```
3545 #
3546 # For a description of IAM and its features, see the
3547 # [IAM documentation](https://cloud.google.com/iam/docs/).
3548 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3549 { # Specifies the audit configuration for a service.
3550 # The configuration determines which permission types are logged, and what
3551 # identities, if any, are exempted from logging.
3552 # An AuditConfig must have one or more AuditLogConfigs.
3553 #
3554 # If there are AuditConfigs for both `allServices` and a specific service,
3555 # the union of the two AuditConfigs is used for that service: the log_types
3556 # specified in each AuditConfig are enabled, and the exempted_members in each
3557 # AuditLogConfig are exempted.
3558 #
3559 # Example Policy with multiple AuditConfigs:
3560 #
3561 # {
3562 # &quot;audit_configs&quot;: [
3563 # {
3564 # &quot;service&quot;: &quot;allServices&quot;,
3565 # &quot;audit_log_configs&quot;: [
3566 # {
3567 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3568 # &quot;exempted_members&quot;: [
3569 # &quot;user:[email protected]&quot;
3570 # ]
3571 # },
3572 # {
3573 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3574 # },
3575 # {
3576 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3577 # }
3578 # ]
3579 # },
3580 # {
3581 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3582 # &quot;audit_log_configs&quot;: [
3583 # {
3584 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3585 # },
3586 # {
3587 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3588 # &quot;exempted_members&quot;: [
3589 # &quot;user:[email protected]&quot;
3590 # ]
3591 # }
3592 # ]
3593 # }
3594 # ]
3595 # }
3596 #
3597 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3598 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3599 # `[email protected]` from DATA_WRITE logging.
3600 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3601 { # Provides the configuration for logging a type of permissions.
3602 # Example:
3603 #
3604 # {
3605 # &quot;audit_log_configs&quot;: [
3606 # {
3607 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3608 # &quot;exempted_members&quot;: [
3609 # &quot;user:[email protected]&quot;
3610 # ]
3611 # },
3612 # {
3613 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3614 # }
3615 # ]
3616 # }
3617 #
3618 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3619 # [email protected] from DATA_READ logging.
3620 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3621 # permission.
3622 # Follows the same format of Binding.members.
3623 &quot;A String&quot;,
3624 ],
3625 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3626 },
3627 ],
3628 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3629 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3630 # `allServices` is a special value that covers all services.
3631 },
3632 ],
3633 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3634 # may specify a `condition` that determines how and when the `bindings` are
3635 # applied. Each of the `bindings` must contain at least one principal.
3636 #
3637 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3638 # of these principals can be Google groups. Each occurrence of a principal
3639 # counts towards these limits. For example, if the `bindings` grant 50
3640 # different roles to `user:[email protected]`, and not to any other
3641 # principal, then you can add another 1,450 principals to the `bindings` in
3642 # the `Policy`.
3643 { # Associates `members`, or principals, with a `role`.
3644 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3645 #
3646 # If the condition evaluates to `true`, then this binding applies to the
3647 # current request.
3648 #
3649 # If the condition evaluates to `false`, then this binding does not apply to
3650 # the current request. However, a different role binding might grant the same
3651 # role to one or more of the principals in this binding.
3652 #
3653 # To learn which resources support conditions in their IAM policies, see the
3654 # [IAM
3655 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3656 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3657 # are documented at https://github.com/google/cel-spec.
3658 #
3659 # Example (Comparison):
3660 #
3661 # title: &quot;Summary size limit&quot;
3662 # description: &quot;Determines if a summary is less than 100 chars&quot;
3663 # expression: &quot;document.summary.size() &lt; 100&quot;
3664 #
3665 # Example (Equality):
3666 #
3667 # title: &quot;Requestor is owner&quot;
3668 # description: &quot;Determines if requestor is the document owner&quot;
3669 # expression: &quot;document.owner == request.auth.claims.email&quot;
3670 #
3671 # Example (Logic):
3672 #
3673 # title: &quot;Public documents&quot;
3674 # description: &quot;Determine whether the document should be publicly visible&quot;
3675 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3676 #
3677 # Example (Data Manipulation):
3678 #
3679 # title: &quot;Notification string&quot;
3680 # description: &quot;Create a notification string with a timestamp.&quot;
3681 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3682 #
3683 # The exact variables and functions that may be referenced within an expression
3684 # are determined by the service that evaluates it. See the service
3685 # documentation for additional information.
3686 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3687 # describes the expression, e.g. when hovered over it in a UI.
3688 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3689 # syntax.
3690 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3691 # reporting, e.g. a file name and a position in the file.
3692 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3693 # its purpose. This can be used e.g. in UIs which allow to enter the
3694 # expression.
3695 },
3696 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3697 # `members` can have the following values:
3698 #
3699 # * `allUsers`: A special identifier that represents anyone who is
3700 # on the internet; with or without a Google account.
3701 #
3702 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3703 # who is authenticated with a Google account or a service account.
3704 # Does not include identities that come from external identity providers
3705 # (IdPs) through identity federation.
3706 #
3707 # * `user:{emailid}`: An email address that represents a specific Google
3708 # account. For example, `[email protected]` .
3709 #
3710 #
3711 # * `serviceAccount:{emailid}`: An email address that represents a Google
3712 # service account. For example,
3713 # `[email protected]`.
3714 #
3715 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3716 # identifier for a
3717 # [Kubernetes service
3718 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3719 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3720 #
3721 # * `group:{emailid}`: An email address that represents a Google group.
3722 # For example, `[email protected]`.
3723 #
3724 #
3725 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3726 # users of that domain. For example, `google.com` or `example.com`.
3727 #
3728 #
3729 #
3730 #
3731 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3732 # A single identity in a workforce identity pool.
3733 #
3734 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3735 # All workforce identities in a group.
3736 #
3737 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3738 # All workforce identities with a specific attribute value.
3739 #
3740 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3741 # All identities in a workforce identity pool.
3742 #
3743 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3744 # A single identity in a workload identity pool.
3745 #
3746 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3747 # A workload identity pool group.
3748 #
3749 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3750 # All identities in a workload identity pool with a certain attribute.
3751 #
3752 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3753 # All identities in a workload identity pool.
3754 #
3755 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3756 # identifier) representing a user that has been recently deleted. For
3757 # example, `[email protected]?uid=123456789012345678901`. If the user is
3758 # recovered, this value reverts to `user:{emailid}` and the recovered user
3759 # retains the role in the binding.
3760 #
3761 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3762 # unique identifier) representing a service account that has been recently
3763 # deleted. For example,
3764 # `[email protected]?uid=123456789012345678901`.
3765 # If the service account is undeleted, this value reverts to
3766 # `serviceAccount:{emailid}` and the undeleted service account retains the
3767 # role in the binding.
3768 #
3769 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3770 # identifier) representing a Google group that has been recently
3771 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3772 # the group is recovered, this value reverts to `group:{emailid}` and the
3773 # recovered group retains the role in the binding.
3774 #
3775 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3776 # Deleted single identity in a workforce identity pool. For example,
3777 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3778 &quot;A String&quot;,
3779 ],
3780 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3781 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3782 #
3783 # For an overview of the IAM roles and permissions, see the
3784 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3785 # a list of the available pre-defined roles, see
3786 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3787 },
3788 ],
3789 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3790 # prevent simultaneous updates of a policy from overwriting each other.
3791 # It is strongly suggested that systems make use of the `etag` in the
3792 # read-modify-write cycle to perform policy updates in order to avoid race
3793 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3794 # systems are expected to put that etag in the request to `setIamPolicy` to
3795 # ensure that their change will be applied to the same version of the policy.
3796 #
3797 # **Important:** If you use IAM Conditions, you must include the `etag` field
3798 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3799 # you to overwrite a version `3` policy with a version `1` policy, and all of
3800 # the conditions in the version `3` policy are lost.
3801 &quot;version&quot;: 42, # Specifies the format of the policy.
3802 #
3803 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3804 # are rejected.
3805 #
3806 # Any operation that affects conditional role bindings must specify version
3807 # `3`. This requirement applies to the following operations:
3808 #
3809 # * Getting a policy that includes a conditional role binding
3810 # * Adding a conditional role binding to a policy
3811 # * Changing a conditional role binding in a policy
3812 # * Removing any role binding, with or without a condition, from a policy
3813 # that includes conditions
3814 #
3815 # **Important:** If you use IAM Conditions, you must include the `etag` field
3816 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3817 # you to overwrite a version `3` policy with a version `1` policy, and all of
3818 # the conditions in the version `3` policy are lost.
3819 #
3820 # If a policy does not include any conditions, operations on that policy may
3821 # specify any valid version or leave the field unset.
3822 #
3823 # To learn which resources support conditions in their IAM policies, see the
3824 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3825 }</pre>
3826 </div>
3827
3828 <div class="method">
3829 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceImage=None, x__xgafv=None)</code>
3830 <pre>Creates a persistent disk in the specified project using the data
3831 in the request. You can create a disk from a source
3832 (sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by
3833 omitting all properties. You can also create a disk that is larger than
3834 the default size by specifying the sizeGb property.
3835
3836 Args:
3837 project: string, Project ID for this request. (required)
3838 zone: string, The name of the zone for this request. (required)
3839 body: object, The request body.
3840 The object takes the form of:
3841
3842 { # Represents a Persistent Disk resource.
3843 #
3844 # Google Compute Engine has two Disk resources:
3845 #
3846 # * [Zonal](/compute/docs/reference/rest/beta/disks)
3847 # * [Regional](/compute/docs/reference/rest/beta/regionDisks)
3848 #
3849 # Persistent disks are required for running your VM instances.
3850 # Create both boot and non-boot (data) persistent disks. For more information,
3851 # read Persistent Disks. For more
3852 # storage options, read Storage options.
3853 #
3854 # The disks resource represents a zonal persistent disk.
3855 # For more information, readZonal persistent disks.
3856 #
3857 # The regionDisks resource represents a
3858 # regional persistent disk. For more information, read
3859 # Regional resources.
3860 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
3861 #
3862 #
3863 # - READ_WRITE_SINGLE: The default AccessMode, means the
3864 # disk can be attached to single instance in RW mode.
3865 # - READ_WRITE_MANY: The AccessMode means the disk can be
3866 # attached to multiple instances in RW mode.
3867 # - READ_ONLY_MANY: The AccessMode means the disk can be
3868 # attached to multiple instances in RO mode.
3869 #
3870 #
3871 # The AccessMode is only valid for Hyperdisk disk types.
3872 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
3873 # ARM64 or X86_64.
3874 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
3875 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
3876 # started on the disk as a member of a group.
3877 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
3878 # started on the disk as a member of a group.
3879 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
3880 # You can provide this as a partial or full URL to the resource.
3881 # For example, the following are valid values:
3882 #
3883 #
3884 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3885 # - projects/project/zones/zone/disks/disk
3886 # - zones/zone/disks/disk
3887 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
3888 # to or from the current disk. This value identifies the exact disk that
3889 # was used to create this replication. For example, if you started
3890 # replicating the persistent disk from a disk that was later deleted and
3891 # recreated under the same name, the disk ID would identify the exact
3892 # version of the disk that was used.
3893 },
3894 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
3895 &quot;a_key&quot;: {
3896 &quot;asyncReplicationDisk&quot;: {
3897 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
3898 # started on the disk as a member of a group.
3899 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
3900 # started on the disk as a member of a group.
3901 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
3902 # You can provide this as a partial or full URL to the resource.
3903 # For example, the following are valid values:
3904 #
3905 #
3906 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3907 # - projects/project/zones/zone/disks/disk
3908 # - zones/zone/disks/disk
3909 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
3910 # to or from the current disk. This value identifies the exact disk that
3911 # was used to create this replication. For example, if you started
3912 # replicating the persistent disk from a disk that was later deleted and
3913 # recreated under the same name, the disk ID would identify the exact
3914 # version of the disk that was used.
3915 },
3916 },
3917 },
3918 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3919 # text format.
3920 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3921 # create the resource.
3922 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
3923 # customer-supplied encryption key or a
3924 # customer-managed encryption key.
3925 #
3926 # Encryption keys do not protect access to metadata of the disk.
3927 #
3928 # After you encrypt a disk with a customer-supplied key, you must provide the
3929 # same key if you use the disk later. For example, to create a disk snapshot,
3930 # to create a disk image, to create a machine image, or to attach the disk to
3931 # a virtual machine.
3932 #
3933 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
3934 # name once the disk is created. The disk is encrypted with this version of
3935 # the key. In the response, diskEncryptionKey.kmsKeyName appears
3936 # in the following format:
3937 #
3938 # &quot;diskEncryptionKey.kmsKeyName&quot;:
3939 # &quot;projects/kms_project_id/locations/region/keyRings/
3940 # key_region/cryptoKeys/key
3941 # /cryptoKeysVersions/version
3942 #
3943 # If you do not provide an encryption key when creating the disk, then the
3944 # disk is encrypted using an automatically generated key and you don&#x27;t need
3945 # to provide a key to use the disk later.
3946 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3947 # For example:
3948 #
3949 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3950 # key_region/cryptoKeys/key
3951 #
3952 # The fully-qualifed key name may be returned for resource GET requests. For
3953 # example:
3954 #
3955 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3956 # key_region/cryptoKeys/key
3957 # /cryptoKeyVersions/1
3958 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3959 # key. If absent, the Compute Engine default service account is used.
3960 # For example:
3961 #
3962 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3963 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3964 # encryption key, encoded in RFC
3965 # 4648 base64 to either encrypt or decrypt this resource. You can
3966 # provide either the rawKey or thersaEncryptedKey.
3967 # For example:
3968 #
3969 # &quot;rawKey&quot;:
3970 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3971 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3972 # customer-supplied encryption key to either encrypt or decrypt this
3973 # resource. You can provide either the rawKey or thersaEncryptedKey.
3974 # For example:
3975 #
3976 # &quot;rsaEncryptedKey&quot;:
3977 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3978 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3979 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3980 #
3981 # The key must meet the following requirements before you can provide it to
3982 # Compute Engine:
3983 #
3984 # 1. The key is wrapped using a RSA public key certificate provided by
3985 # Google.
3986 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3987 # encoding.
3988 #
3989 # Gets the RSA public key certificate provided by Google at:
3990 #
3991 #
3992 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3993 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3994 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3995 # encryption key that protects this resource.
3996 },
3997 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3998 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disk restored from a source snapshot should erase
3999 # Windows specific VSS signature.
4000 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4001 # only for bootable images. Read
4002 # Enabling guest operating system features to see a list of available
4003 # options.
4004 { # Guest OS features.
4005 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4006 # separate values. Set to one or more of the following values:
4007 #
4008 # - VIRTIO_SCSI_MULTIQUEUE
4009 # - WINDOWS
4010 # - MULTI_IP_SUBNET
4011 # - UEFI_COMPATIBLE
4012 # - GVNIC
4013 # - SEV_CAPABLE
4014 # - SUSPEND_RESUME_COMPATIBLE
4015 # - SEV_LIVE_MIGRATABLE_V2
4016 # - SEV_SNP_CAPABLE
4017 # - TDX_CAPABLE
4018 # - IDPF
4019 # - SNP_SVSM_CAPABLE
4020 # - CCA_CAPABLE
4021 #
4022 #
4023 # For more information, see
4024 # Enabling guest operating system features.
4025 },
4026 ],
4027 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
4028 # defined by the server.
4029 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
4030 # which is either SCSI or NVME. The default isSCSI.
4031 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
4032 # disks.
4033 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
4034 # essentially a hash of the labels set used for optimistic locking. The
4035 # fingerprint is initially generated by Compute Engine and changes after
4036 # every request to modify or update labels. You must always provide an
4037 # up-to-date fingerprint hash in order to update or change labels,
4038 # otherwise the request will fail with error412 conditionNotMet.
4039 #
4040 # To see the latest fingerprint, make a get() request to
4041 # retrieve a disk.
4042 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
4043 # the setLabels method.
4044 &quot;a_key&quot;: &quot;A String&quot;,
4045 },
4046 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
4047 # text format.
4048 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
4049 # text format.
4050 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
4051 &quot;A String&quot;,
4052 ],
4053 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4054 &quot;A String&quot;,
4055 ],
4056 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
4057 # This field is for use by internal tools that use the public API.
4058 &quot;locked&quot;: True or False, # Output only. [Output Only] The field indicates if the disk is created from a locked
4059 # source image. Attachment of a disk created from a locked source image will
4060 # cause the following operations to become irreversibly prohibited:
4061 #
4062 # - R/W or R/O disk attachment to any other instance
4063 # - Disk detachment. And the disk can only be deleted when the instance
4064 # is deleted
4065 # - Creation of images or snapshots
4066 # - Disk cloning
4067 #
4068 #
4069 #
4070 # Furthermore, the instance with at least one disk with locked flag set to
4071 # true will be prohibited from performing the operations below:
4072 #
4073 # - Further attachment of secondary disks.
4074 # - Detachment of any disks
4075 # - Create machine images
4076 # - Create instance template
4077 # - Delete the instance with --keep-disk parameter set to true for locked
4078 # disks
4079 # - Attach a locked disk with --auto-delete parameter set to false
4080 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
4081 # more than one instance.
4082 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4083 # The name must be 1-63 characters long, and comply withRFC1035.
4084 # Specifically, the name must be 1-63 characters long and match the regular
4085 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
4086 # which means the first character must be a lowercase letter, and all
4087 # following characters must be a dash, lowercase letter, or digit, except
4088 # the last character, which cannot be a dash.
4089 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
4090 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
4091 # as part of resource payload.
4092 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4093 # have the same definition as resource
4094 # manager tags. Keys and values can be either in numeric format,
4095 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4096 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4097 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
4098 # PATCH) when empty.
4099 &quot;a_key&quot;: &quot;A String&quot;,
4100 },
4101 },
4102 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
4103 # If not present in a request, a default value is used.
4104 # The currently supported size is 4096, other sizes may be added in
4105 # the future.
4106 # If an unsupported value is requested, the error message will list
4107 # the supported values for the caller&#x27;s project.
4108 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4109 # of I/O operations per second that the disk can handle. Values must be
4110 # between 10,000 and 120,000. For more details, see theExtreme persistent
4111 # disk documentation.
4112 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4113 # number of throughput mb per second that the disk can handle. Values must be
4114 # greater than or equal to 1.
4115 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
4116 # regional resources.
4117 # You must specify this field as part of the HTTP request URL. It is
4118 # not settable as a field in the request body.
4119 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
4120 # for regional resources.
4121 &quot;A String&quot;,
4122 ],
4123 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4124 &quot;A String&quot;,
4125 ],
4126 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
4127 &quot;asyncPrimaryDisk&quot;: {
4128 &quot;state&quot;: &quot;A String&quot;,
4129 },
4130 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
4131 &quot;a_key&quot;: {
4132 &quot;state&quot;: &quot;A String&quot;,
4133 },
4134 },
4135 },
4136 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
4137 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
4138 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
4139 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
4140 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
4141 # persistent disk.
4142 #
4143 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
4144 # source.
4145 # Acceptable values are greater than 0.
4146 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
4147 # that was created using a consistency group.
4148 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
4149 # that was created using a consistency group.
4150 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
4151 # partial or full URL to the resource. For example, the following are valid
4152 # values:
4153 #
4154 #
4155 # -
4156 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4157 #
4158 # -
4159 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
4160 #
4161 # -
4162 # projects/project/zones/zone/disks/disk
4163 #
4164 # -
4165 # projects/project/regions/region/disks/disk
4166 #
4167 # -
4168 # zones/zone/disks/disk
4169 #
4170 # -
4171 # regions/region/disks/disk
4172 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
4173 # value identifies the exact disk that was used to create this persistent
4174 # disk. For example, if you created the persistent disk from a disk that
4175 # was later deleted and recreated under the same name, the source disk ID
4176 # would identify the exact version of the disk that was used.
4177 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
4178 # deleted, this field will not be set.
4179 #
4180 # To create a disk with one of the public operating system images, specify
4181 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4182 #
4183 # projects/debian-cloud/global/images/family/debian-9
4184 #
4185 #
4186 # Alternatively, use a specific version of a public operating system image:
4187 #
4188 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4189 #
4190 #
4191 # To create a disk with a custom image that you created, specify the
4192 # image name in the following format:
4193 #
4194 # global/images/my-custom-image
4195 #
4196 #
4197 # You can also specify a custom image by its image family, which returns
4198 # the latest version of the image in that family. Replace the image name
4199 # with family/family-name:
4200 #
4201 # global/images/family/my-image-family
4202 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4203 # encryption key of the source image. Required if the source image is
4204 # protected by a customer-supplied encryption key.
4205 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4206 # For example:
4207 #
4208 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4209 # key_region/cryptoKeys/key
4210 #
4211 # The fully-qualifed key name may be returned for resource GET requests. For
4212 # example:
4213 #
4214 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4215 # key_region/cryptoKeys/key
4216 # /cryptoKeyVersions/1
4217 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4218 # key. If absent, the Compute Engine default service account is used.
4219 # For example:
4220 #
4221 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4222 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4223 # encryption key, encoded in RFC
4224 # 4648 base64 to either encrypt or decrypt this resource. You can
4225 # provide either the rawKey or thersaEncryptedKey.
4226 # For example:
4227 #
4228 # &quot;rawKey&quot;:
4229 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4230 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4231 # customer-supplied encryption key to either encrypt or decrypt this
4232 # resource. You can provide either the rawKey or thersaEncryptedKey.
4233 # For example:
4234 #
4235 # &quot;rsaEncryptedKey&quot;:
4236 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4237 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4238 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4239 #
4240 # The key must meet the following requirements before you can provide it to
4241 # Compute Engine:
4242 #
4243 # 1. The key is wrapped using a RSA public key certificate provided by
4244 # Google.
4245 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4246 # encoding.
4247 #
4248 # Gets the RSA public key certificate provided by Google at:
4249 #
4250 #
4251 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4252 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4253 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4254 # encryption key that protects this resource.
4255 },
4256 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
4257 # value identifies the exact image that was used to create this persistent
4258 # disk. For example, if you created the persistent disk from an image that
4259 # was later deleted and recreated under the same name, the source image ID
4260 # would identify the exact version of the image that was used.
4261 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
4262 # this as a partial or full URL to the resource. For example, the following
4263 # are valid values:
4264 #
4265 #
4266 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
4267 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
4268 # - zones/zone/instantSnapshots/instantSnapshot
4269 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
4270 # disk. This value identifies the exact instant snapshot that was used to
4271 # create this persistent disk. For example, if you created the persistent
4272 # disk from an instant snapshot that was later deleted and recreated under
4273 # the same name, the source instant snapshot ID would identify the exact
4274 # version of the instant snapshot that was used.
4275 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # The machine image to create the disk from. You can provide this as a
4276 # partial or full URL to the resource. For example, the following are valid
4277 # values:
4278 #
4279 #
4280 # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage
4281 # - projects/project/global/machineImages/machineImage
4282 # - global/machineImages/machineImage
4283 &quot;sourceMachineImageDiskDeviceName&quot;: &quot;A String&quot;, # The device name of a disk within a given machine image. The
4284 # source_machine_image must be specified.
4285 &quot;sourceMachineImageEncryptionKey&quot;: { # Thecustomer-supplied
4286 # encryption key of the source machine image. Required if the source
4287 # machine image is protected by a customer-supplied encryption key.
4288 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4289 # For example:
4290 #
4291 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4292 # key_region/cryptoKeys/key
4293 #
4294 # The fully-qualifed key name may be returned for resource GET requests. For
4295 # example:
4296 #
4297 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4298 # key_region/cryptoKeys/key
4299 # /cryptoKeyVersions/1
4300 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4301 # key. If absent, the Compute Engine default service account is used.
4302 # For example:
4303 #
4304 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4305 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4306 # encryption key, encoded in RFC
4307 # 4648 base64 to either encrypt or decrypt this resource. You can
4308 # provide either the rawKey or thersaEncryptedKey.
4309 # For example:
4310 #
4311 # &quot;rawKey&quot;:
4312 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4313 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4314 # customer-supplied encryption key to either encrypt or decrypt this
4315 # resource. You can provide either the rawKey or thersaEncryptedKey.
4316 # For example:
4317 #
4318 # &quot;rsaEncryptedKey&quot;:
4319 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4320 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4321 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4322 #
4323 # The key must meet the following requirements before you can provide it to
4324 # Compute Engine:
4325 #
4326 # 1. The key is wrapped using a RSA public key certificate provided by
4327 # Google.
4328 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4329 # encoding.
4330 #
4331 # Gets the RSA public key certificate provided by Google at:
4332 #
4333 #
4334 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4335 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4336 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4337 # encryption key that protects this resource.
4338 },
4339 &quot;sourceMachineImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the machine image used to create this disk.
4340 # This value identifies the exact machine image that was used to create this
4341 # persistent disk. For example, if you created the persistent disk from a
4342 # machine image that was later deleted and recreated under the same name, the
4343 # source machine image ID would identify the exact version of the machine
4344 # image that was used.
4345 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
4346 # partial or full URL to the resource. For example, the following are valid
4347 # values:
4348 #
4349 #
4350 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
4351 # - projects/project/global/snapshots/snapshot
4352 # - global/snapshots/snapshot
4353 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4354 # encryption key of the source snapshot. Required if the source snapshot
4355 # is protected by a customer-supplied encryption key.
4356 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4357 # For example:
4358 #
4359 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4360 # key_region/cryptoKeys/key
4361 #
4362 # The fully-qualifed key name may be returned for resource GET requests. For
4363 # example:
4364 #
4365 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4366 # key_region/cryptoKeys/key
4367 # /cryptoKeyVersions/1
4368 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4369 # key. If absent, the Compute Engine default service account is used.
4370 # For example:
4371 #
4372 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4373 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4374 # encryption key, encoded in RFC
4375 # 4648 base64 to either encrypt or decrypt this resource. You can
4376 # provide either the rawKey or thersaEncryptedKey.
4377 # For example:
4378 #
4379 # &quot;rawKey&quot;:
4380 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4381 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4382 # customer-supplied encryption key to either encrypt or decrypt this
4383 # resource. You can provide either the rawKey or thersaEncryptedKey.
4384 # For example:
4385 #
4386 # &quot;rsaEncryptedKey&quot;:
4387 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4388 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4389 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4390 #
4391 # The key must meet the following requirements before you can provide it to
4392 # Compute Engine:
4393 #
4394 # 1. The key is wrapped using a RSA public key certificate provided by
4395 # Google.
4396 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4397 # encoding.
4398 #
4399 # Gets the RSA public key certificate provided by Google at:
4400 #
4401 #
4402 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4403 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4404 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4405 # encryption key that protects this resource.
4406 },
4407 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
4408 # value identifies the exact snapshot that was used to create this persistent
4409 # disk. For example, if you created the persistent disk from a snapshot that
4410 # was later deleted and recreated under the same name, the source snapshot ID
4411 # would identify the exact version of the snapshot that was used.
4412 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
4413 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
4414 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
4415 # https://storage.googleapis.com/. This flag is not optimized for creating
4416 # multiple disks from a source storage object. To create many disks from a
4417 # source storage object, use gcloud compute images
4418 # import instead.
4419 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
4420 #
4421 #
4422 # - CREATING: Disk is provisioning.
4423 # - RESTORING: Source data is being copied into the
4424 # disk.
4425 # - FAILED: Disk creation failed.
4426 # - READY: Disk is ready for use.
4427 # - DELETING: Disk is deleting.
4428 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4429 # this as a partial or full URL to the resource. For example, the following
4430 # are valid values:
4431 #
4432 #
4433 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4434 # - projects/project/zones/zone/storagePools/storagePool
4435 # - zones/zone/storagePools/storagePool
4436 &quot;storageType&quot;: &quot;A String&quot;, # [Deprecated] Storage type of the persistent disk.
4437 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
4438 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
4439 # types.
4440 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
4441 # in form:projects/project/zones/zone/instances/instance
4442 &quot;A String&quot;,
4443 ],
4444 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
4445 # You must specify this field as part of the HTTP request URL. It is
4446 # not settable as a field in the request body.
4447 }
4448
4449 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4450 that if you must retry your request, the server will know to ignore the
4451 request if it has already been completed.
4452
4453 For example, consider a situation where you make an initial request and
4454 the request times out. If you make the request again with the same
4455 request ID, the server can check if original operation with the same
4456 request ID was received, and if so, will ignore the second request. This
4457 prevents clients from accidentally creating duplicate commitments.
4458
4459 The request ID must be
4460 a valid UUID with the exception that zero UUID is not supported
4461 (00000000-0000-0000-0000-000000000000).
4462 sourceImage: string, Source image to restore onto a disk. This field is optional.
4463 x__xgafv: string, V1 error format.
4464 Allowed values
4465 1 - v1 error format
4466 2 - v2 error format
4467
4468 Returns:
4469 An object of the form:
4470
4471 { # Represents an Operation resource.
4472 #
4473 # Google Compute Engine has three Operation resources:
4474 #
4475 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
4476 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
4477 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
4478 #
4479 # You can use an operation resource to manage asynchronous API requests.
4480 # For more information, readHandling
4481 # API responses.
4482 #
4483 # Operations can be global, regional or zonal.
4484 #
4485 # - For global operations, use the `globalOperations`
4486 # resource.
4487 # - For regional operations, use the
4488 # `regionOperations` resource.
4489 # - For zonal operations, use
4490 # the `zoneOperations` resource.
4491 #
4492 #
4493 #
4494 # For more information, read
4495 # Global, Regional, and Zonal Resources.
4496 #
4497 # Note that completed Operation resources have a limited
4498 # retention period.
4499 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4500 # Not present otherwise.
4501 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4502 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4503 # set when the operation is created.
4504 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4505 # text format.
4506 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4507 # this field will be populated.
4508 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4509 # operation.
4510 {
4511 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4512 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4513 # details. There is a set of defined message types to use for providing
4514 # details.The syntax depends on the error code. For example,
4515 # QuotaExceededInfo will have details when the error code is
4516 # QUOTA_EXCEEDED.
4517 {
4518 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4519 #
4520 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4521 # is not enabled:
4522 #
4523 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4524 # &quot;domain&quot;: &quot;googleapis.com&quot;
4525 # &quot;metadata&quot;: {
4526 # &quot;resource&quot;: &quot;projects/123&quot;,
4527 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4528 # }
4529 # }
4530 #
4531 # This response indicates that the pubsub.googleapis.com API is not enabled.
4532 #
4533 # Example of an error that is returned when attempting to create a Spanner
4534 # instance in a region that is out of stock:
4535 #
4536 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4537 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4538 # &quot;metadata&quot;: {
4539 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4540 # }
4541 # }
4542 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4543 # is typically the registered service name of the tool or product that
4544 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4545 # generated by some common infrastructure, the error domain must be a
4546 # globally unique value that identifies the infrastructure. For Google API
4547 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4548 &quot;metadatas&quot;: { # Additional structured details about this error.
4549 #
4550 # Keys must match a regular expression of `a-z+` but should
4551 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4552 # length. When identifying the current value of an exceeded limit, the units
4553 # should be contained in the key, not the value. For example, rather than
4554 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4555 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4556 # instances that can be created in a single (batch) request.
4557 &quot;a_key&quot;: &quot;A String&quot;,
4558 },
4559 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4560 # proximate cause of the error. Error reasons are unique within a particular
4561 # domain of errors. This should be at most 63 characters and match a
4562 # regular expression of `A-Z+[A-Z0-9]`, which represents
4563 # UPPER_SNAKE_CASE.
4564 },
4565 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4566 #
4567 # For example, if a quota check failed with an error indicating the calling
4568 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4569 # directly to the right place in the developer console to flip the bit.
4570 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4571 { # Describes a URL link.
4572 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4573 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4574 },
4575 ],
4576 },
4577 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4578 # which can be attached to an RPC error.
4579 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4580 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4581 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4582 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4583 },
4584 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4585 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4586 &quot;a_key&quot;: &quot;A String&quot;,
4587 },
4588 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4589 # type or metric.
4590 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4591 # or metric.
4592 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4593 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4594 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4595 },
4596 },
4597 ],
4598 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4599 # This property is optional.
4600 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4601 },
4602 ],
4603 },
4604 &quot;getVersionOperationMetadata&quot;: {
4605 &quot;inlineSbomInfo&quot;: {
4606 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4607 # appropriate identifiers.
4608 &quot;a_key&quot;: &quot;A String&quot;,
4609 },
4610 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4611 # identifiers.
4612 &quot;a_key&quot;: &quot;A String&quot;,
4613 },
4614 },
4615 },
4616 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4617 # message that was returned, such as `NOT FOUND`.
4618 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4619 # status code that was returned. For example, a `404` means the
4620 # resource was not found.
4621 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4622 # defined by the server.
4623 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4624 # This value is inRFC3339
4625 # text format.
4626 &quot;instancesBulkInsertOperationMetadata&quot;: {
4627 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4628 # Example key: zones/us-central1-a
4629 &quot;a_key&quot;: {
4630 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4631 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4632 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4633 # error.
4634 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4635 # if the flow is rolling forward or rolling back.
4636 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4637 },
4638 },
4639 },
4640 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4641 # Operation resources.
4642 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4643 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4644 # group of operations results from a `bulkInsert` API request.
4645 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4646 # `update`, or `delete`, and so on.
4647 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4648 # There is no requirement that this be linear or support any granularity of
4649 # operations. This should not be used to guess when the operation will be
4650 # complete. This number should monotonically increase as the operation
4651 # progresses.
4652 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4653 # applicable when performing regional operations.
4654 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4655 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4656 # this field will contain information on all underlying zonal actions and
4657 # their state.
4658 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4659 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4660 # Example key: zones/us-central1-a
4661 &quot;a_key&quot;: {
4662 &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
4663 # populated.
4664 # different programming environments, including REST APIs and RPC APIs. It is
4665 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4666 # three pieces of data: error code, error message, and error details.
4667 #
4668 # You can find out more about this error model and how to work with it in the
4669 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4670 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4671 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4672 # message types for APIs to use.
4673 {
4674 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4675 },
4676 ],
4677 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4678 # user-facing error message should be localized and sent in the
4679 # google.rpc.Status.details field, or localized by the client.
4680 },
4681 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4682 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4683 },
4684 },
4685 },
4686 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4687 # This value is inRFC3339
4688 # text format.
4689 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4690 # following:
4691 # `PENDING`, `RUNNING`, or `DONE`.
4692 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4693 # operation.
4694 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4695 # of the target resource.
4696 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4697 # operations related to creating a snapshot, this points to the disk
4698 # that the snapshot was created from.
4699 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4700 # `[email protected]` or
4701 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4702 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4703 # operation, this field will be populated.
4704 {
4705 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4706 # Engine returns NO_RESULTS_ON_PAGE if there
4707 # are no results in the response.
4708 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4709 # value format. For example:
4710 #
4711 # &quot;data&quot;: [
4712 # {
4713 # &quot;key&quot;: &quot;scope&quot;,
4714 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4715 # }
4716 {
4717 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4718 # returned. For example, for warnings where there are no results in a list
4719 # request for a particular zone, this key might be scope and
4720 # the key value might be the zone name. Other examples might be a key
4721 # indicating a deprecated resource and a suggested replacement, or a
4722 # warning about invalid network settings (for example, if an instance
4723 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4724 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4725 },
4726 ],
4727 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4728 },
4729 ],
4730 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4731 # applicable when performing per-zone operations.
4732 }</pre>
4733 </div>
4734
4735 <div class="method">
4736 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4737 <pre>Retrieves a list of persistent disks contained within
4738 the specified zone.
4739
4740 Args:
4741 project: string, Project ID for this request. (required)
4742 zone: string, The name of the zone for this request. (required)
4743 filter: string, A filter expression that filters resources listed in the response. Most
4744 Compute resources support two types of filter expressions:
4745 expressions that support regular expressions and expressions that follow
4746 API improvement proposal AIP-160.
4747 These two types of filter expressions cannot be mixed in one request.
4748
4749 If you want to use AIP-160, your expression must specify the field name, an
4750 operator, and the value that you want to use for filtering. The value
4751 must be a string, a number, or a boolean. The operator
4752 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4753
4754 For example, if you are filtering Compute Engine instances, you can
4755 exclude instances named `example-instance` by specifying
4756 `name != example-instance`.
4757
4758 The `:*` comparison can be used to test whether a key has been defined.
4759 For example, to find all objects with `owner` label use:
4760 ```
4761 labels.owner:*
4762 ```
4763
4764 You can also filter nested fields. For example, you could specify
4765 `scheduling.automaticRestart = false` to include instances only
4766 if they are not scheduled for automatic restarts. You can use filtering
4767 on nested fields to filter based onresource labels.
4768
4769 To filter on multiple expressions, provide each separate expression within
4770 parentheses. For example:
4771 ```
4772 (scheduling.automaticRestart = true)
4773 (cpuPlatform = &quot;Intel Skylake&quot;)
4774 ```
4775 By default, each expression is an `AND` expression. However, you
4776 can include `AND` and `OR` expressions explicitly.
4777 For example:
4778 ```
4779 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4780 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4781 (scheduling.automaticRestart = true)
4782 ```
4783
4784 If you want to use a regular expression, use the `eq` (equal) or `ne`
4785 (not equal) operator against a single un-parenthesized expression with or
4786 without quotes or against multiple parenthesized expressions. Examples:
4787
4788 `fieldname eq unquoted literal`
4789 `fieldname eq &#x27;single quoted literal&#x27;`
4790 `fieldname eq &quot;double quoted literal&quot;`
4791 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4792
4793 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4794 The literal value must match the entire field.
4795
4796 For example, to filter for instances that do not end with name &quot;instance&quot;,
4797 you would use `name ne .*instance`.
4798
4799 You cannot combine constraints on multiple fields using regular
4800 expressions.
4801 maxResults: integer, The maximum number of results per page that should be returned.
4802 If the number of available results is larger than `maxResults`,
4803 Compute Engine returns a `nextPageToken` that can be used to get
4804 the next page of results in subsequent list requests. Acceptable values are
4805 `0` to `500`, inclusive. (Default: `500`)
4806 orderBy: string, Sorts list results by a certain order. By default, results
4807 are returned in alphanumerical order based on the resource name.
4808
4809 You can also sort results in descending order based on the creation
4810 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4811 results based on the `creationTimestamp` field in
4812 reverse chronological order (newest result first). Use this to sort
4813 resources like operations so that the newest operation is returned first.
4814
4815 Currently, only sorting by `name` or
4816 `creationTimestamp desc` is supported.
4817 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4818 `nextPageToken` returned by a previous list request to get
4819 the next page of results.
4820 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4821 of failure. The default value is false.
4822
4823 For example, when partial success behavior is enabled, aggregatedList for a
4824 single zone scope either returns all resources in the zone or no resources,
4825 with an error code.
4826 x__xgafv: string, V1 error format.
4827 Allowed values
4828 1 - v1 error format
4829 2 - v2 error format
4830
4831 Returns:
4832 An object of the form:
4833
4834 { # A list of Disk resources.
4835 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4836 &quot;items&quot;: [ # A list of Disk resources.
4837 { # Represents a Persistent Disk resource.
4838 #
4839 # Google Compute Engine has two Disk resources:
4840 #
4841 # * [Zonal](/compute/docs/reference/rest/beta/disks)
4842 # * [Regional](/compute/docs/reference/rest/beta/regionDisks)
4843 #
4844 # Persistent disks are required for running your VM instances.
4845 # Create both boot and non-boot (data) persistent disks. For more information,
4846 # read Persistent Disks. For more
4847 # storage options, read Storage options.
4848 #
4849 # The disks resource represents a zonal persistent disk.
4850 # For more information, readZonal persistent disks.
4851 #
4852 # The regionDisks resource represents a
4853 # regional persistent disk. For more information, read
4854 # Regional resources.
4855 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
4856 #
4857 #
4858 # - READ_WRITE_SINGLE: The default AccessMode, means the
4859 # disk can be attached to single instance in RW mode.
4860 # - READ_WRITE_MANY: The AccessMode means the disk can be
4861 # attached to multiple instances in RW mode.
4862 # - READ_ONLY_MANY: The AccessMode means the disk can be
4863 # attached to multiple instances in RO mode.
4864 #
4865 #
4866 # The AccessMode is only valid for Hyperdisk disk types.
4867 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
4868 # ARM64 or X86_64.
4869 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
4870 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
4871 # started on the disk as a member of a group.
4872 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
4873 # started on the disk as a member of a group.
4874 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
4875 # You can provide this as a partial or full URL to the resource.
4876 # For example, the following are valid values:
4877 #
4878 #
4879 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4880 # - projects/project/zones/zone/disks/disk
4881 # - zones/zone/disks/disk
4882 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
4883 # to or from the current disk. This value identifies the exact disk that
4884 # was used to create this replication. For example, if you started
4885 # replicating the persistent disk from a disk that was later deleted and
4886 # recreated under the same name, the disk ID would identify the exact
4887 # version of the disk that was used.
4888 },
4889 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
4890 &quot;a_key&quot;: {
4891 &quot;asyncReplicationDisk&quot;: {
4892 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
4893 # started on the disk as a member of a group.
4894 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
4895 # started on the disk as a member of a group.
4896 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
4897 # You can provide this as a partial or full URL to the resource.
4898 # For example, the following are valid values:
4899 #
4900 #
4901 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4902 # - projects/project/zones/zone/disks/disk
4903 # - zones/zone/disks/disk
4904 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
4905 # to or from the current disk. This value identifies the exact disk that
4906 # was used to create this replication. For example, if you started
4907 # replicating the persistent disk from a disk that was later deleted and
4908 # recreated under the same name, the disk ID would identify the exact
4909 # version of the disk that was used.
4910 },
4911 },
4912 },
4913 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4914 # text format.
4915 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4916 # create the resource.
4917 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
4918 # customer-supplied encryption key or a
4919 # customer-managed encryption key.
4920 #
4921 # Encryption keys do not protect access to metadata of the disk.
4922 #
4923 # After you encrypt a disk with a customer-supplied key, you must provide the
4924 # same key if you use the disk later. For example, to create a disk snapshot,
4925 # to create a disk image, to create a machine image, or to attach the disk to
4926 # a virtual machine.
4927 #
4928 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
4929 # name once the disk is created. The disk is encrypted with this version of
4930 # the key. In the response, diskEncryptionKey.kmsKeyName appears
4931 # in the following format:
4932 #
4933 # &quot;diskEncryptionKey.kmsKeyName&quot;:
4934 # &quot;projects/kms_project_id/locations/region/keyRings/
4935 # key_region/cryptoKeys/key
4936 # /cryptoKeysVersions/version
4937 #
4938 # If you do not provide an encryption key when creating the disk, then the
4939 # disk is encrypted using an automatically generated key and you don&#x27;t need
4940 # to provide a key to use the disk later.
4941 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4942 # For example:
4943 #
4944 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4945 # key_region/cryptoKeys/key
4946 #
4947 # The fully-qualifed key name may be returned for resource GET requests. For
4948 # example:
4949 #
4950 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4951 # key_region/cryptoKeys/key
4952 # /cryptoKeyVersions/1
4953 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4954 # key. If absent, the Compute Engine default service account is used.
4955 # For example:
4956 #
4957 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4958 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4959 # encryption key, encoded in RFC
4960 # 4648 base64 to either encrypt or decrypt this resource. You can
4961 # provide either the rawKey or thersaEncryptedKey.
4962 # For example:
4963 #
4964 # &quot;rawKey&quot;:
4965 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4966 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4967 # customer-supplied encryption key to either encrypt or decrypt this
4968 # resource. You can provide either the rawKey or thersaEncryptedKey.
4969 # For example:
4970 #
4971 # &quot;rsaEncryptedKey&quot;:
4972 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4973 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4974 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4975 #
4976 # The key must meet the following requirements before you can provide it to
4977 # Compute Engine:
4978 #
4979 # 1. The key is wrapped using a RSA public key certificate provided by
4980 # Google.
4981 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4982 # encoding.
4983 #
4984 # Gets the RSA public key certificate provided by Google at:
4985 #
4986 #
4987 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4988 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4989 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4990 # encryption key that protects this resource.
4991 },
4992 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4993 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disk restored from a source snapshot should erase
4994 # Windows specific VSS signature.
4995 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4996 # only for bootable images. Read
4997 # Enabling guest operating system features to see a list of available
4998 # options.
4999 { # Guest OS features.
5000 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
5001 # separate values. Set to one or more of the following values:
5002 #
5003 # - VIRTIO_SCSI_MULTIQUEUE
5004 # - WINDOWS
5005 # - MULTI_IP_SUBNET
5006 # - UEFI_COMPATIBLE
5007 # - GVNIC
5008 # - SEV_CAPABLE
5009 # - SUSPEND_RESUME_COMPATIBLE
5010 # - SEV_LIVE_MIGRATABLE_V2
5011 # - SEV_SNP_CAPABLE
5012 # - TDX_CAPABLE
5013 # - IDPF
5014 # - SNP_SVSM_CAPABLE
5015 # - CCA_CAPABLE
5016 #
5017 #
5018 # For more information, see
5019 # Enabling guest operating system features.
5020 },
5021 ],
5022 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
5023 # defined by the server.
5024 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
5025 # which is either SCSI or NVME. The default isSCSI.
5026 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
5027 # disks.
5028 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
5029 # essentially a hash of the labels set used for optimistic locking. The
5030 # fingerprint is initially generated by Compute Engine and changes after
5031 # every request to modify or update labels. You must always provide an
5032 # up-to-date fingerprint hash in order to update or change labels,
5033 # otherwise the request will fail with error412 conditionNotMet.
5034 #
5035 # To see the latest fingerprint, make a get() request to
5036 # retrieve a disk.
5037 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
5038 # the setLabels method.
5039 &quot;a_key&quot;: &quot;A String&quot;,
5040 },
5041 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
5042 # text format.
5043 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
5044 # text format.
5045 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
5046 &quot;A String&quot;,
5047 ],
5048 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
5049 &quot;A String&quot;,
5050 ],
5051 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
5052 # This field is for use by internal tools that use the public API.
5053 &quot;locked&quot;: True or False, # Output only. [Output Only] The field indicates if the disk is created from a locked
5054 # source image. Attachment of a disk created from a locked source image will
5055 # cause the following operations to become irreversibly prohibited:
5056 #
5057 # - R/W or R/O disk attachment to any other instance
5058 # - Disk detachment. And the disk can only be deleted when the instance
5059 # is deleted
5060 # - Creation of images or snapshots
5061 # - Disk cloning
5062 #
5063 #
5064 #
5065 # Furthermore, the instance with at least one disk with locked flag set to
5066 # true will be prohibited from performing the operations below:
5067 #
5068 # - Further attachment of secondary disks.
5069 # - Detachment of any disks
5070 # - Create machine images
5071 # - Create instance template
5072 # - Delete the instance with --keep-disk parameter set to true for locked
5073 # disks
5074 # - Attach a locked disk with --auto-delete parameter set to false
5075 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
5076 # more than one instance.
5077 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
5078 # The name must be 1-63 characters long, and comply withRFC1035.
5079 # Specifically, the name must be 1-63 characters long and match the regular
5080 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
5081 # which means the first character must be a lowercase letter, and all
5082 # following characters must be a dash, lowercase letter, or digit, except
5083 # the last character, which cannot be a dash.
5084 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
5085 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
5086 # as part of resource payload.
5087 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
5088 # have the same definition as resource
5089 # manager tags. Keys and values can be either in numeric format,
5090 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
5091 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
5092 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
5093 # PATCH) when empty.
5094 &quot;a_key&quot;: &quot;A String&quot;,
5095 },
5096 },
5097 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
5098 # If not present in a request, a default value is used.
5099 # The currently supported size is 4096, other sizes may be added in
5100 # the future.
5101 # If an unsupported value is requested, the error message will list
5102 # the supported values for the caller&#x27;s project.
5103 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
5104 # of I/O operations per second that the disk can handle. Values must be
5105 # between 10,000 and 120,000. For more details, see theExtreme persistent
5106 # disk documentation.
5107 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
5108 # number of throughput mb per second that the disk can handle. Values must be
5109 # greater than or equal to 1.
5110 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
5111 # regional resources.
5112 # You must specify this field as part of the HTTP request URL. It is
5113 # not settable as a field in the request body.
5114 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
5115 # for regional resources.
5116 &quot;A String&quot;,
5117 ],
5118 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
5119 &quot;A String&quot;,
5120 ],
5121 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
5122 &quot;asyncPrimaryDisk&quot;: {
5123 &quot;state&quot;: &quot;A String&quot;,
5124 },
5125 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
5126 &quot;a_key&quot;: {
5127 &quot;state&quot;: &quot;A String&quot;,
5128 },
5129 },
5130 },
5131 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
5132 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
5133 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
5134 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
5135 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
5136 # persistent disk.
5137 #
5138 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
5139 # source.
5140 # Acceptable values are greater than 0.
5141 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
5142 # that was created using a consistency group.
5143 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
5144 # that was created using a consistency group.
5145 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
5146 # partial or full URL to the resource. For example, the following are valid
5147 # values:
5148 #
5149 #
5150 # -
5151 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
5152 #
5153 # -
5154 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
5155 #
5156 # -
5157 # projects/project/zones/zone/disks/disk
5158 #
5159 # -
5160 # projects/project/regions/region/disks/disk
5161 #
5162 # -
5163 # zones/zone/disks/disk
5164 #
5165 # -
5166 # regions/region/disks/disk
5167 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
5168 # value identifies the exact disk that was used to create this persistent
5169 # disk. For example, if you created the persistent disk from a disk that
5170 # was later deleted and recreated under the same name, the source disk ID
5171 # would identify the exact version of the disk that was used.
5172 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
5173 # deleted, this field will not be set.
5174 #
5175 # To create a disk with one of the public operating system images, specify
5176 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
5177 #
5178 # projects/debian-cloud/global/images/family/debian-9
5179 #
5180 #
5181 # Alternatively, use a specific version of a public operating system image:
5182 #
5183 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
5184 #
5185 #
5186 # To create a disk with a custom image that you created, specify the
5187 # image name in the following format:
5188 #
5189 # global/images/my-custom-image
5190 #
5191 #
5192 # You can also specify a custom image by its image family, which returns
5193 # the latest version of the image in that family. Replace the image name
5194 # with family/family-name:
5195 #
5196 # global/images/family/my-image-family
5197 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
5198 # encryption key of the source image. Required if the source image is
5199 # protected by a customer-supplied encryption key.
5200 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
5201 # For example:
5202 #
5203 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5204 # key_region/cryptoKeys/key
5205 #
5206 # The fully-qualifed key name may be returned for resource GET requests. For
5207 # example:
5208 #
5209 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5210 # key_region/cryptoKeys/key
5211 # /cryptoKeyVersions/1
5212 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
5213 # key. If absent, the Compute Engine default service account is used.
5214 # For example:
5215 #
5216 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
5217 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
5218 # encryption key, encoded in RFC
5219 # 4648 base64 to either encrypt or decrypt this resource. You can
5220 # provide either the rawKey or thersaEncryptedKey.
5221 # For example:
5222 #
5223 # &quot;rawKey&quot;:
5224 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
5225 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
5226 # customer-supplied encryption key to either encrypt or decrypt this
5227 # resource. You can provide either the rawKey or thersaEncryptedKey.
5228 # For example:
5229 #
5230 # &quot;rsaEncryptedKey&quot;:
5231 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
5232 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
5233 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
5234 #
5235 # The key must meet the following requirements before you can provide it to
5236 # Compute Engine:
5237 #
5238 # 1. The key is wrapped using a RSA public key certificate provided by
5239 # Google.
5240 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
5241 # encoding.
5242 #
5243 # Gets the RSA public key certificate provided by Google at:
5244 #
5245 #
5246 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
5247 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
5248 # 4648 base64 encoded SHA-256 hash of the customer-supplied
5249 # encryption key that protects this resource.
5250 },
5251 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
5252 # value identifies the exact image that was used to create this persistent
5253 # disk. For example, if you created the persistent disk from an image that
5254 # was later deleted and recreated under the same name, the source image ID
5255 # would identify the exact version of the image that was used.
5256 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
5257 # this as a partial or full URL to the resource. For example, the following
5258 # are valid values:
5259 #
5260 #
5261 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
5262 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
5263 # - zones/zone/instantSnapshots/instantSnapshot
5264 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
5265 # disk. This value identifies the exact instant snapshot that was used to
5266 # create this persistent disk. For example, if you created the persistent
5267 # disk from an instant snapshot that was later deleted and recreated under
5268 # the same name, the source instant snapshot ID would identify the exact
5269 # version of the instant snapshot that was used.
5270 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # The machine image to create the disk from. You can provide this as a
5271 # partial or full URL to the resource. For example, the following are valid
5272 # values:
5273 #
5274 #
5275 # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage
5276 # - projects/project/global/machineImages/machineImage
5277 # - global/machineImages/machineImage
5278 &quot;sourceMachineImageDiskDeviceName&quot;: &quot;A String&quot;, # The device name of a disk within a given machine image. The
5279 # source_machine_image must be specified.
5280 &quot;sourceMachineImageEncryptionKey&quot;: { # Thecustomer-supplied
5281 # encryption key of the source machine image. Required if the source
5282 # machine image is protected by a customer-supplied encryption key.
5283 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
5284 # For example:
5285 #
5286 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5287 # key_region/cryptoKeys/key
5288 #
5289 # The fully-qualifed key name may be returned for resource GET requests. For
5290 # example:
5291 #
5292 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5293 # key_region/cryptoKeys/key
5294 # /cryptoKeyVersions/1
5295 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
5296 # key. If absent, the Compute Engine default service account is used.
5297 # For example:
5298 #
5299 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
5300 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
5301 # encryption key, encoded in RFC
5302 # 4648 base64 to either encrypt or decrypt this resource. You can
5303 # provide either the rawKey or thersaEncryptedKey.
5304 # For example:
5305 #
5306 # &quot;rawKey&quot;:
5307 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
5308 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
5309 # customer-supplied encryption key to either encrypt or decrypt this
5310 # resource. You can provide either the rawKey or thersaEncryptedKey.
5311 # For example:
5312 #
5313 # &quot;rsaEncryptedKey&quot;:
5314 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
5315 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
5316 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
5317 #
5318 # The key must meet the following requirements before you can provide it to
5319 # Compute Engine:
5320 #
5321 # 1. The key is wrapped using a RSA public key certificate provided by
5322 # Google.
5323 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
5324 # encoding.
5325 #
5326 # Gets the RSA public key certificate provided by Google at:
5327 #
5328 #
5329 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
5330 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
5331 # 4648 base64 encoded SHA-256 hash of the customer-supplied
5332 # encryption key that protects this resource.
5333 },
5334 &quot;sourceMachineImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the machine image used to create this disk.
5335 # This value identifies the exact machine image that was used to create this
5336 # persistent disk. For example, if you created the persistent disk from a
5337 # machine image that was later deleted and recreated under the same name, the
5338 # source machine image ID would identify the exact version of the machine
5339 # image that was used.
5340 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
5341 # partial or full URL to the resource. For example, the following are valid
5342 # values:
5343 #
5344 #
5345 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
5346 # - projects/project/global/snapshots/snapshot
5347 # - global/snapshots/snapshot
5348 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
5349 # encryption key of the source snapshot. Required if the source snapshot
5350 # is protected by a customer-supplied encryption key.
5351 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
5352 # For example:
5353 #
5354 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5355 # key_region/cryptoKeys/key
5356 #
5357 # The fully-qualifed key name may be returned for resource GET requests. For
5358 # example:
5359 #
5360 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
5361 # key_region/cryptoKeys/key
5362 # /cryptoKeyVersions/1
5363 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
5364 # key. If absent, the Compute Engine default service account is used.
5365 # For example:
5366 #
5367 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
5368 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
5369 # encryption key, encoded in RFC
5370 # 4648 base64 to either encrypt or decrypt this resource. You can
5371 # provide either the rawKey or thersaEncryptedKey.
5372 # For example:
5373 #
5374 # &quot;rawKey&quot;:
5375 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
5376 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
5377 # customer-supplied encryption key to either encrypt or decrypt this
5378 # resource. You can provide either the rawKey or thersaEncryptedKey.
5379 # For example:
5380 #
5381 # &quot;rsaEncryptedKey&quot;:
5382 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
5383 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
5384 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
5385 #
5386 # The key must meet the following requirements before you can provide it to
5387 # Compute Engine:
5388 #
5389 # 1. The key is wrapped using a RSA public key certificate provided by
5390 # Google.
5391 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
5392 # encoding.
5393 #
5394 # Gets the RSA public key certificate provided by Google at:
5395 #
5396 #
5397 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
5398 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
5399 # 4648 base64 encoded SHA-256 hash of the customer-supplied
5400 # encryption key that protects this resource.
5401 },
5402 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
5403 # value identifies the exact snapshot that was used to create this persistent
5404 # disk. For example, if you created the persistent disk from a snapshot that
5405 # was later deleted and recreated under the same name, the source snapshot ID
5406 # would identify the exact version of the snapshot that was used.
5407 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
5408 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
5409 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
5410 # https://storage.googleapis.com/. This flag is not optimized for creating
5411 # multiple disks from a source storage object. To create many disks from a
5412 # source storage object, use gcloud compute images
5413 # import instead.
5414 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
5415 #
5416 #
5417 # - CREATING: Disk is provisioning.
5418 # - RESTORING: Source data is being copied into the
5419 # disk.
5420 # - FAILED: Disk creation failed.
5421 # - READY: Disk is ready for use.
5422 # - DELETING: Disk is deleting.
5423 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
5424 # this as a partial or full URL to the resource. For example, the following
5425 # are valid values:
5426 #
5427 #
5428 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
5429 # - projects/project/zones/zone/storagePools/storagePool
5430 # - zones/zone/storagePools/storagePool
5431 &quot;storageType&quot;: &quot;A String&quot;, # [Deprecated] Storage type of the persistent disk.
5432 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
5433 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
5434 # types.
5435 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
5436 # in form:projects/project/zones/zone/instances/instance
5437 &quot;A String&quot;,
5438 ],
5439 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
5440 # You must specify this field as part of the HTTP request URL. It is
5441 # not settable as a field in the request body.
5442 },
5443 ],
5444 &quot;kind&quot;: &quot;compute#diskList&quot;, # Output only. [Output Only] Type of resource. Always compute#diskList for
5445 # lists of disks.
5446 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5447 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5448 # the query parameter pageToken in the next list request.
5449 # Subsequent list requests will have their own nextPageToken to
5450 # continue paging through the results.
5451 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5452 &quot;warning&quot;: { # [Output Only] Informational warning message.
5453 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5454 # Engine returns NO_RESULTS_ON_PAGE if there
5455 # are no results in the response.
5456 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5457 # value format. For example:
5458 #
5459 # &quot;data&quot;: [
5460 # {
5461 # &quot;key&quot;: &quot;scope&quot;,
5462 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5463 # }
5464 {
5465 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5466 # returned. For example, for warnings where there are no results in a list
5467 # request for a particular zone, this key might be scope and
5468 # the key value might be the zone name. Other examples might be a key
5469 # indicating a deprecated resource and a suggested replacement, or a
5470 # warning about invalid network settings (for example, if an instance
5471 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5472 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5473 },
5474 ],
5475 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5476 },
5477 }</pre>
5478 </div>
5479
5480 <div class="method">
5481 <code class="details" id="list_next">list_next()</code>
5482 <pre>Retrieves the next page of results.
5483
5484 Args:
5485 previous_request: The request for the previous page. (required)
5486 previous_response: The response from the request for the previous page. (required)
5487
5488 Returns:
5489 A request object that you can call &#x27;execute()&#x27; on to request the next
5490 page. Returns None if there are no more items in the collection.
5491 </pre>
5492 </div>
5493
5494 <div class="method">
5495 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
5496 <pre>Removes resource policies from a disk.
5497
5498 Args:
5499 project: string, Project ID for this request. (required)
5500 zone: string, The name of the zone for this request. (required)
5501 disk: string, The disk name for this request. (required)
5502 body: object, The request body.
5503 The object takes the form of:
5504
5505 {
5506 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this disk.
5507 &quot;A String&quot;,
5508 ],
5509 }
5510
5511 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5512 that if you must retry your request, the server will know to ignore the
5513 request if it has already been completed.
5514
5515 For example, consider a situation where you make an initial request and
5516 the request times out. If you make the request again with the same
5517 request ID, the server can check if original operation with the same
5518 request ID was received, and if so, will ignore the second request. This
5519 prevents clients from accidentally creating duplicate commitments.
5520
5521 The request ID must be
5522 a valid UUID with the exception that zero UUID is not supported
5523 (00000000-0000-0000-0000-000000000000).
5524 x__xgafv: string, V1 error format.
5525 Allowed values
5526 1 - v1 error format
5527 2 - v2 error format
5528
5529 Returns:
5530 An object of the form:
5531
5532 { # Represents an Operation resource.
5533 #
5534 # Google Compute Engine has three Operation resources:
5535 #
5536 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5537 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5538 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5539 #
5540 # You can use an operation resource to manage asynchronous API requests.
5541 # For more information, readHandling
5542 # API responses.
5543 #
5544 # Operations can be global, regional or zonal.
5545 #
5546 # - For global operations, use the `globalOperations`
5547 # resource.
5548 # - For regional operations, use the
5549 # `regionOperations` resource.
5550 # - For zonal operations, use
5551 # the `zoneOperations` resource.
5552 #
5553 #
5554 #
5555 # For more information, read
5556 # Global, Regional, and Zonal Resources.
5557 #
5558 # Note that completed Operation resources have a limited
5559 # retention period.
5560 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5561 # Not present otherwise.
5562 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5563 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5564 # set when the operation is created.
5565 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5566 # text format.
5567 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5568 # this field will be populated.
5569 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5570 # operation.
5571 {
5572 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5573 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5574 # details. There is a set of defined message types to use for providing
5575 # details.The syntax depends on the error code. For example,
5576 # QuotaExceededInfo will have details when the error code is
5577 # QUOTA_EXCEEDED.
5578 {
5579 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5580 #
5581 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5582 # is not enabled:
5583 #
5584 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5585 # &quot;domain&quot;: &quot;googleapis.com&quot;
5586 # &quot;metadata&quot;: {
5587 # &quot;resource&quot;: &quot;projects/123&quot;,
5588 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5589 # }
5590 # }
5591 #
5592 # This response indicates that the pubsub.googleapis.com API is not enabled.
5593 #
5594 # Example of an error that is returned when attempting to create a Spanner
5595 # instance in a region that is out of stock:
5596 #
5597 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5598 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5599 # &quot;metadata&quot;: {
5600 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5601 # }
5602 # }
5603 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5604 # is typically the registered service name of the tool or product that
5605 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5606 # generated by some common infrastructure, the error domain must be a
5607 # globally unique value that identifies the infrastructure. For Google API
5608 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5609 &quot;metadatas&quot;: { # Additional structured details about this error.
5610 #
5611 # Keys must match a regular expression of `a-z+` but should
5612 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5613 # length. When identifying the current value of an exceeded limit, the units
5614 # should be contained in the key, not the value. For example, rather than
5615 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5616 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5617 # instances that can be created in a single (batch) request.
5618 &quot;a_key&quot;: &quot;A String&quot;,
5619 },
5620 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5621 # proximate cause of the error. Error reasons are unique within a particular
5622 # domain of errors. This should be at most 63 characters and match a
5623 # regular expression of `A-Z+[A-Z0-9]`, which represents
5624 # UPPER_SNAKE_CASE.
5625 },
5626 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5627 #
5628 # For example, if a quota check failed with an error indicating the calling
5629 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5630 # directly to the right place in the developer console to flip the bit.
5631 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5632 { # Describes a URL link.
5633 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5634 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5635 },
5636 ],
5637 },
5638 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5639 # which can be attached to an RPC error.
5640 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5641 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5642 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5643 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5644 },
5645 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5646 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5647 &quot;a_key&quot;: &quot;A String&quot;,
5648 },
5649 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5650 # type or metric.
5651 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5652 # or metric.
5653 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5654 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5655 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5656 },
5657 },
5658 ],
5659 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5660 # This property is optional.
5661 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5662 },
5663 ],
5664 },
5665 &quot;getVersionOperationMetadata&quot;: {
5666 &quot;inlineSbomInfo&quot;: {
5667 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5668 # appropriate identifiers.
5669 &quot;a_key&quot;: &quot;A String&quot;,
5670 },
5671 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5672 # identifiers.
5673 &quot;a_key&quot;: &quot;A String&quot;,
5674 },
5675 },
5676 },
5677 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5678 # message that was returned, such as `NOT FOUND`.
5679 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5680 # status code that was returned. For example, a `404` means the
5681 # resource was not found.
5682 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5683 # defined by the server.
5684 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5685 # This value is inRFC3339
5686 # text format.
5687 &quot;instancesBulkInsertOperationMetadata&quot;: {
5688 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5689 # Example key: zones/us-central1-a
5690 &quot;a_key&quot;: {
5691 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5692 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5693 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5694 # error.
5695 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5696 # if the flow is rolling forward or rolling back.
5697 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5698 },
5699 },
5700 },
5701 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5702 # Operation resources.
5703 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5704 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5705 # group of operations results from a `bulkInsert` API request.
5706 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5707 # `update`, or `delete`, and so on.
5708 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5709 # There is no requirement that this be linear or support any granularity of
5710 # operations. This should not be used to guess when the operation will be
5711 # complete. This number should monotonically increase as the operation
5712 # progresses.
5713 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5714 # applicable when performing regional operations.
5715 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5716 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5717 # this field will contain information on all underlying zonal actions and
5718 # their state.
5719 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5720 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5721 # Example key: zones/us-central1-a
5722 &quot;a_key&quot;: {
5723 &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
5724 # populated.
5725 # different programming environments, including REST APIs and RPC APIs. It is
5726 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5727 # three pieces of data: error code, error message, and error details.
5728 #
5729 # You can find out more about this error model and how to work with it in the
5730 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5731 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5732 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5733 # message types for APIs to use.
5734 {
5735 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5736 },
5737 ],
5738 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5739 # user-facing error message should be localized and sent in the
5740 # google.rpc.Status.details field, or localized by the client.
5741 },
5742 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5743 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5744 },
5745 },
5746 },
5747 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5748 # This value is inRFC3339
5749 # text format.
5750 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5751 # following:
5752 # `PENDING`, `RUNNING`, or `DONE`.
5753 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5754 # operation.
5755 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5756 # of the target resource.
5757 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5758 # operations related to creating a snapshot, this points to the disk
5759 # that the snapshot was created from.
5760 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5761 # `[email protected]` or
5762 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5763 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5764 # operation, this field will be populated.
5765 {
5766 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5767 # Engine returns NO_RESULTS_ON_PAGE if there
5768 # are no results in the response.
5769 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5770 # value format. For example:
5771 #
5772 # &quot;data&quot;: [
5773 # {
5774 # &quot;key&quot;: &quot;scope&quot;,
5775 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5776 # }
5777 {
5778 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5779 # returned. For example, for warnings where there are no results in a list
5780 # request for a particular zone, this key might be scope and
5781 # the key value might be the zone name. Other examples might be a key
5782 # indicating a deprecated resource and a suggested replacement, or a
5783 # warning about invalid network settings (for example, if an instance
5784 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5785 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5786 },
5787 ],
5788 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5789 },
5790 ],
5791 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5792 # applicable when performing per-zone operations.
5793 }</pre>
5794 </div>
5795
5796 <div class="method">
5797 <code class="details" id="resize">resize(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
5798 <pre>Resizes the specified persistent disk.
5799 You can only increase the size of the disk.
5800
5801 Args:
5802 project: string, Project ID for this request. (required)
5803 zone: string, The name of the zone for this request. (required)
5804 disk: string, The name of the persistent disk. (required)
5805 body: object, The request body.
5806 The object takes the form of:
5807
5808 {
5809 &quot;sizeGb&quot;: &quot;A String&quot;, # The new size of the persistent disk, which is specified in GB.
5810 }
5811
5812 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5813 that if you must retry your request, the server will know to ignore the
5814 request if it has already been completed.
5815
5816 For example, consider a situation where you make an initial request and
5817 the request times out. If you make the request again with the same
5818 request ID, the server can check if original operation with the same
5819 request ID was received, and if so, will ignore the second request. This
5820 prevents clients from accidentally creating duplicate commitments.
5821
5822 The request ID must be
5823 a valid UUID with the exception that zero UUID is not supported
5824 (00000000-0000-0000-0000-000000000000).
5825 x__xgafv: string, V1 error format.
5826 Allowed values
5827 1 - v1 error format
5828 2 - v2 error format
5829
5830 Returns:
5831 An object of the form:
5832
5833 { # Represents an Operation resource.
5834 #
5835 # Google Compute Engine has three Operation resources:
5836 #
5837 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
5838 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
5839 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
5840 #
5841 # You can use an operation resource to manage asynchronous API requests.
5842 # For more information, readHandling
5843 # API responses.
5844 #
5845 # Operations can be global, regional or zonal.
5846 #
5847 # - For global operations, use the `globalOperations`
5848 # resource.
5849 # - For regional operations, use the
5850 # `regionOperations` resource.
5851 # - For zonal operations, use
5852 # the `zoneOperations` resource.
5853 #
5854 #
5855 #
5856 # For more information, read
5857 # Global, Regional, and Zonal Resources.
5858 #
5859 # Note that completed Operation resources have a limited
5860 # retention period.
5861 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5862 # Not present otherwise.
5863 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5864 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5865 # set when the operation is created.
5866 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5867 # text format.
5868 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5869 # this field will be populated.
5870 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5871 # operation.
5872 {
5873 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5874 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5875 # details. There is a set of defined message types to use for providing
5876 # details.The syntax depends on the error code. For example,
5877 # QuotaExceededInfo will have details when the error code is
5878 # QUOTA_EXCEEDED.
5879 {
5880 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5881 #
5882 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5883 # is not enabled:
5884 #
5885 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5886 # &quot;domain&quot;: &quot;googleapis.com&quot;
5887 # &quot;metadata&quot;: {
5888 # &quot;resource&quot;: &quot;projects/123&quot;,
5889 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5890 # }
5891 # }
5892 #
5893 # This response indicates that the pubsub.googleapis.com API is not enabled.
5894 #
5895 # Example of an error that is returned when attempting to create a Spanner
5896 # instance in a region that is out of stock:
5897 #
5898 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5899 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5900 # &quot;metadata&quot;: {
5901 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5902 # }
5903 # }
5904 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5905 # is typically the registered service name of the tool or product that
5906 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5907 # generated by some common infrastructure, the error domain must be a
5908 # globally unique value that identifies the infrastructure. For Google API
5909 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5910 &quot;metadatas&quot;: { # Additional structured details about this error.
5911 #
5912 # Keys must match a regular expression of `a-z+` but should
5913 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5914 # length. When identifying the current value of an exceeded limit, the units
5915 # should be contained in the key, not the value. For example, rather than
5916 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5917 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5918 # instances that can be created in a single (batch) request.
5919 &quot;a_key&quot;: &quot;A String&quot;,
5920 },
5921 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5922 # proximate cause of the error. Error reasons are unique within a particular
5923 # domain of errors. This should be at most 63 characters and match a
5924 # regular expression of `A-Z+[A-Z0-9]`, which represents
5925 # UPPER_SNAKE_CASE.
5926 },
5927 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5928 #
5929 # For example, if a quota check failed with an error indicating the calling
5930 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5931 # directly to the right place in the developer console to flip the bit.
5932 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5933 { # Describes a URL link.
5934 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5935 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5936 },
5937 ],
5938 },
5939 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5940 # which can be attached to an RPC error.
5941 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5942 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5943 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5944 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5945 },
5946 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5947 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5948 &quot;a_key&quot;: &quot;A String&quot;,
5949 },
5950 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5951 # type or metric.
5952 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5953 # or metric.
5954 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5955 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5956 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5957 },
5958 },
5959 ],
5960 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5961 # This property is optional.
5962 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5963 },
5964 ],
5965 },
5966 &quot;getVersionOperationMetadata&quot;: {
5967 &quot;inlineSbomInfo&quot;: {
5968 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5969 # appropriate identifiers.
5970 &quot;a_key&quot;: &quot;A String&quot;,
5971 },
5972 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5973 # identifiers.
5974 &quot;a_key&quot;: &quot;A String&quot;,
5975 },
5976 },
5977 },
5978 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5979 # message that was returned, such as `NOT FOUND`.
5980 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5981 # status code that was returned. For example, a `404` means the
5982 # resource was not found.
5983 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5984 # defined by the server.
5985 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5986 # This value is inRFC3339
5987 # text format.
5988 &quot;instancesBulkInsertOperationMetadata&quot;: {
5989 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5990 # Example key: zones/us-central1-a
5991 &quot;a_key&quot;: {
5992 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5993 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5994 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5995 # error.
5996 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5997 # if the flow is rolling forward or rolling back.
5998 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5999 },
6000 },
6001 },
6002 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6003 # Operation resources.
6004 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6005 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6006 # group of operations results from a `bulkInsert` API request.
6007 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6008 # `update`, or `delete`, and so on.
6009 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6010 # There is no requirement that this be linear or support any granularity of
6011 # operations. This should not be used to guess when the operation will be
6012 # complete. This number should monotonically increase as the operation
6013 # progresses.
6014 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6015 # applicable when performing regional operations.
6016 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6017 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6018 # this field will contain information on all underlying zonal actions and
6019 # their state.
6020 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6021 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6022 # Example key: zones/us-central1-a
6023 &quot;a_key&quot;: {
6024 &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
6025 # populated.
6026 # different programming environments, including REST APIs and RPC APIs. It is
6027 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6028 # three pieces of data: error code, error message, and error details.
6029 #
6030 # You can find out more about this error model and how to work with it in the
6031 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6032 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6033 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6034 # message types for APIs to use.
6035 {
6036 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6037 },
6038 ],
6039 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6040 # user-facing error message should be localized and sent in the
6041 # google.rpc.Status.details field, or localized by the client.
6042 },
6043 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6044 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6045 },
6046 },
6047 },
6048 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6049 # This value is inRFC3339
6050 # text format.
6051 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6052 # following:
6053 # `PENDING`, `RUNNING`, or `DONE`.
6054 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6055 # operation.
6056 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6057 # of the target resource.
6058 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6059 # operations related to creating a snapshot, this points to the disk
6060 # that the snapshot was created from.
6061 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6062 # `[email protected]` or
6063 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6064 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6065 # operation, this field will be populated.
6066 {
6067 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6068 # Engine returns NO_RESULTS_ON_PAGE if there
6069 # are no results in the response.
6070 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6071 # value format. For example:
6072 #
6073 # &quot;data&quot;: [
6074 # {
6075 # &quot;key&quot;: &quot;scope&quot;,
6076 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6077 # }
6078 {
6079 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6080 # returned. For example, for warnings where there are no results in a list
6081 # request for a particular zone, this key might be scope and
6082 # the key value might be the zone name. Other examples might be a key
6083 # indicating a deprecated resource and a suggested replacement, or a
6084 # warning about invalid network settings (for example, if an instance
6085 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6086 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6087 },
6088 ],
6089 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6090 },
6091 ],
6092 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6093 # applicable when performing per-zone operations.
6094 }</pre>
6095 </div>
6096
6097 <div class="method">
6098 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
6099 <pre>Sets the access control policy on the specified resource.
6100 Replaces any existing policy.
6101
6102 Args:
6103 project: string, Project ID for this request. (required)
6104 zone: string, The name of the zone for this request. (required)
6105 resource: string, Name or id of the resource for this request. (required)
6106 body: object, The request body.
6107 The object takes the form of:
6108
6109 {
6110 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
6111 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
6112 { # Associates `members`, or principals, with a `role`.
6113 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6114 #
6115 # If the condition evaluates to `true`, then this binding applies to the
6116 # current request.
6117 #
6118 # If the condition evaluates to `false`, then this binding does not apply to
6119 # the current request. However, a different role binding might grant the same
6120 # role to one or more of the principals in this binding.
6121 #
6122 # To learn which resources support conditions in their IAM policies, see the
6123 # [IAM
6124 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6125 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6126 # are documented at https://github.com/google/cel-spec.
6127 #
6128 # Example (Comparison):
6129 #
6130 # title: &quot;Summary size limit&quot;
6131 # description: &quot;Determines if a summary is less than 100 chars&quot;
6132 # expression: &quot;document.summary.size() &lt; 100&quot;
6133 #
6134 # Example (Equality):
6135 #
6136 # title: &quot;Requestor is owner&quot;
6137 # description: &quot;Determines if requestor is the document owner&quot;
6138 # expression: &quot;document.owner == request.auth.claims.email&quot;
6139 #
6140 # Example (Logic):
6141 #
6142 # title: &quot;Public documents&quot;
6143 # description: &quot;Determine whether the document should be publicly visible&quot;
6144 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6145 #
6146 # Example (Data Manipulation):
6147 #
6148 # title: &quot;Notification string&quot;
6149 # description: &quot;Create a notification string with a timestamp.&quot;
6150 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6151 #
6152 # The exact variables and functions that may be referenced within an expression
6153 # are determined by the service that evaluates it. See the service
6154 # documentation for additional information.
6155 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6156 # describes the expression, e.g. when hovered over it in a UI.
6157 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6158 # syntax.
6159 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6160 # reporting, e.g. a file name and a position in the file.
6161 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6162 # its purpose. This can be used e.g. in UIs which allow to enter the
6163 # expression.
6164 },
6165 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6166 # `members` can have the following values:
6167 #
6168 # * `allUsers`: A special identifier that represents anyone who is
6169 # on the internet; with or without a Google account.
6170 #
6171 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6172 # who is authenticated with a Google account or a service account.
6173 # Does not include identities that come from external identity providers
6174 # (IdPs) through identity federation.
6175 #
6176 # * `user:{emailid}`: An email address that represents a specific Google
6177 # account. For example, `[email protected]` .
6178 #
6179 #
6180 # * `serviceAccount:{emailid}`: An email address that represents a Google
6181 # service account. For example,
6182 # `[email protected]`.
6183 #
6184 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6185 # identifier for a
6186 # [Kubernetes service
6187 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6188 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6189 #
6190 # * `group:{emailid}`: An email address that represents a Google group.
6191 # For example, `[email protected]`.
6192 #
6193 #
6194 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6195 # users of that domain. For example, `google.com` or `example.com`.
6196 #
6197 #
6198 #
6199 #
6200 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6201 # A single identity in a workforce identity pool.
6202 #
6203 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6204 # All workforce identities in a group.
6205 #
6206 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6207 # All workforce identities with a specific attribute value.
6208 #
6209 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6210 # All identities in a workforce identity pool.
6211 #
6212 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6213 # A single identity in a workload identity pool.
6214 #
6215 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6216 # A workload identity pool group.
6217 #
6218 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6219 # All identities in a workload identity pool with a certain attribute.
6220 #
6221 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6222 # All identities in a workload identity pool.
6223 #
6224 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6225 # identifier) representing a user that has been recently deleted. For
6226 # example, `[email protected]?uid=123456789012345678901`. If the user is
6227 # recovered, this value reverts to `user:{emailid}` and the recovered user
6228 # retains the role in the binding.
6229 #
6230 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6231 # unique identifier) representing a service account that has been recently
6232 # deleted. For example,
6233 # `[email protected]?uid=123456789012345678901`.
6234 # If the service account is undeleted, this value reverts to
6235 # `serviceAccount:{emailid}` and the undeleted service account retains the
6236 # role in the binding.
6237 #
6238 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6239 # identifier) representing a Google group that has been recently
6240 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6241 # the group is recovered, this value reverts to `group:{emailid}` and the
6242 # recovered group retains the role in the binding.
6243 #
6244 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6245 # Deleted single identity in a workforce identity pool. For example,
6246 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6247 &quot;A String&quot;,
6248 ],
6249 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6250 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6251 #
6252 # For an overview of the IAM roles and permissions, see the
6253 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6254 # a list of the available pre-defined roles, see
6255 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6256 },
6257 ],
6258 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
6259 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
6260 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the &#x27;resource&#x27;. The size of
6261 # the policy is limited to a few 10s of KB. An empty policy is in general a
6262 # valid policy but certain services (like Projects) might reject them.
6263 # controls for Google Cloud resources.
6264 #
6265 #
6266 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
6267 # `members`, or principals, to a single `role`. Principals can be user
6268 # accounts, service accounts, Google groups, and domains (such as G Suite). A
6269 # `role` is a named list of permissions; each `role` can be an IAM predefined
6270 # role or a user-created custom role.
6271 #
6272 # For some types of Google Cloud resources, a `binding` can also specify a
6273 # `condition`, which is a logical expression that allows access to a resource
6274 # only if the expression evaluates to `true`. A condition can add constraints
6275 # based on attributes of the request, the resource, or both. To learn which
6276 # resources support conditions in their IAM policies, see the
6277 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6278 #
6279 # **JSON example:**
6280 #
6281 # ```
6282 # {
6283 # &quot;bindings&quot;: [
6284 # {
6285 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
6286 # &quot;members&quot;: [
6287 # &quot;user:[email protected]&quot;,
6288 # &quot;group:[email protected]&quot;,
6289 # &quot;domain:google.com&quot;,
6290 # &quot;serviceAccount:[email protected]&quot;
6291 # ]
6292 # },
6293 # {
6294 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
6295 # &quot;members&quot;: [
6296 # &quot;user:[email protected]&quot;
6297 # ],
6298 # &quot;condition&quot;: {
6299 # &quot;title&quot;: &quot;expirable access&quot;,
6300 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
6301 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
6302 # }
6303 # }
6304 # ],
6305 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
6306 # &quot;version&quot;: 3
6307 # }
6308 # ```
6309 #
6310 # **YAML example:**
6311 #
6312 # ```
6313 # bindings:
6314 # - members:
6315 # - user:[email protected]
6316 # - group:[email protected]
6317 # - domain:google.com
6318 # - serviceAccount:[email protected]
6319 # role: roles/resourcemanager.organizationAdmin
6320 # - members:
6321 # - user:[email protected]
6322 # role: roles/resourcemanager.organizationViewer
6323 # condition:
6324 # title: expirable access
6325 # description: Does not grant access after Sep 2020
6326 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
6327 # etag: BwWWja0YfJA=
6328 # version: 3
6329 # ```
6330 #
6331 # For a description of IAM and its features, see the
6332 # [IAM documentation](https://cloud.google.com/iam/docs/).
6333 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
6334 { # Specifies the audit configuration for a service.
6335 # The configuration determines which permission types are logged, and what
6336 # identities, if any, are exempted from logging.
6337 # An AuditConfig must have one or more AuditLogConfigs.
6338 #
6339 # If there are AuditConfigs for both `allServices` and a specific service,
6340 # the union of the two AuditConfigs is used for that service: the log_types
6341 # specified in each AuditConfig are enabled, and the exempted_members in each
6342 # AuditLogConfig are exempted.
6343 #
6344 # Example Policy with multiple AuditConfigs:
6345 #
6346 # {
6347 # &quot;audit_configs&quot;: [
6348 # {
6349 # &quot;service&quot;: &quot;allServices&quot;,
6350 # &quot;audit_log_configs&quot;: [
6351 # {
6352 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6353 # &quot;exempted_members&quot;: [
6354 # &quot;user:[email protected]&quot;
6355 # ]
6356 # },
6357 # {
6358 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6359 # },
6360 # {
6361 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
6362 # }
6363 # ]
6364 # },
6365 # {
6366 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
6367 # &quot;audit_log_configs&quot;: [
6368 # {
6369 # &quot;log_type&quot;: &quot;DATA_READ&quot;
6370 # },
6371 # {
6372 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
6373 # &quot;exempted_members&quot;: [
6374 # &quot;user:[email protected]&quot;
6375 # ]
6376 # }
6377 # ]
6378 # }
6379 # ]
6380 # }
6381 #
6382 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
6383 # logging. It also exempts `[email protected]` from DATA_READ logging, and
6384 # `[email protected]` from DATA_WRITE logging.
6385 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
6386 { # Provides the configuration for logging a type of permissions.
6387 # Example:
6388 #
6389 # {
6390 # &quot;audit_log_configs&quot;: [
6391 # {
6392 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6393 # &quot;exempted_members&quot;: [
6394 # &quot;user:[email protected]&quot;
6395 # ]
6396 # },
6397 # {
6398 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6399 # }
6400 # ]
6401 # }
6402 #
6403 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
6404 # [email protected] from DATA_READ logging.
6405 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
6406 # permission.
6407 # Follows the same format of Binding.members.
6408 &quot;A String&quot;,
6409 ],
6410 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
6411 },
6412 ],
6413 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
6414 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
6415 # `allServices` is a special value that covers all services.
6416 },
6417 ],
6418 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
6419 # may specify a `condition` that determines how and when the `bindings` are
6420 # applied. Each of the `bindings` must contain at least one principal.
6421 #
6422 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
6423 # of these principals can be Google groups. Each occurrence of a principal
6424 # counts towards these limits. For example, if the `bindings` grant 50
6425 # different roles to `user:[email protected]`, and not to any other
6426 # principal, then you can add another 1,450 principals to the `bindings` in
6427 # the `Policy`.
6428 { # Associates `members`, or principals, with a `role`.
6429 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6430 #
6431 # If the condition evaluates to `true`, then this binding applies to the
6432 # current request.
6433 #
6434 # If the condition evaluates to `false`, then this binding does not apply to
6435 # the current request. However, a different role binding might grant the same
6436 # role to one or more of the principals in this binding.
6437 #
6438 # To learn which resources support conditions in their IAM policies, see the
6439 # [IAM
6440 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6441 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6442 # are documented at https://github.com/google/cel-spec.
6443 #
6444 # Example (Comparison):
6445 #
6446 # title: &quot;Summary size limit&quot;
6447 # description: &quot;Determines if a summary is less than 100 chars&quot;
6448 # expression: &quot;document.summary.size() &lt; 100&quot;
6449 #
6450 # Example (Equality):
6451 #
6452 # title: &quot;Requestor is owner&quot;
6453 # description: &quot;Determines if requestor is the document owner&quot;
6454 # expression: &quot;document.owner == request.auth.claims.email&quot;
6455 #
6456 # Example (Logic):
6457 #
6458 # title: &quot;Public documents&quot;
6459 # description: &quot;Determine whether the document should be publicly visible&quot;
6460 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6461 #
6462 # Example (Data Manipulation):
6463 #
6464 # title: &quot;Notification string&quot;
6465 # description: &quot;Create a notification string with a timestamp.&quot;
6466 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6467 #
6468 # The exact variables and functions that may be referenced within an expression
6469 # are determined by the service that evaluates it. See the service
6470 # documentation for additional information.
6471 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6472 # describes the expression, e.g. when hovered over it in a UI.
6473 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6474 # syntax.
6475 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6476 # reporting, e.g. a file name and a position in the file.
6477 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6478 # its purpose. This can be used e.g. in UIs which allow to enter the
6479 # expression.
6480 },
6481 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6482 # `members` can have the following values:
6483 #
6484 # * `allUsers`: A special identifier that represents anyone who is
6485 # on the internet; with or without a Google account.
6486 #
6487 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6488 # who is authenticated with a Google account or a service account.
6489 # Does not include identities that come from external identity providers
6490 # (IdPs) through identity federation.
6491 #
6492 # * `user:{emailid}`: An email address that represents a specific Google
6493 # account. For example, `[email protected]` .
6494 #
6495 #
6496 # * `serviceAccount:{emailid}`: An email address that represents a Google
6497 # service account. For example,
6498 # `[email protected]`.
6499 #
6500 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6501 # identifier for a
6502 # [Kubernetes service
6503 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6504 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6505 #
6506 # * `group:{emailid}`: An email address that represents a Google group.
6507 # For example, `[email protected]`.
6508 #
6509 #
6510 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6511 # users of that domain. For example, `google.com` or `example.com`.
6512 #
6513 #
6514 #
6515 #
6516 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6517 # A single identity in a workforce identity pool.
6518 #
6519 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6520 # All workforce identities in a group.
6521 #
6522 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6523 # All workforce identities with a specific attribute value.
6524 #
6525 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6526 # All identities in a workforce identity pool.
6527 #
6528 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6529 # A single identity in a workload identity pool.
6530 #
6531 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6532 # A workload identity pool group.
6533 #
6534 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6535 # All identities in a workload identity pool with a certain attribute.
6536 #
6537 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6538 # All identities in a workload identity pool.
6539 #
6540 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6541 # identifier) representing a user that has been recently deleted. For
6542 # example, `[email protected]?uid=123456789012345678901`. If the user is
6543 # recovered, this value reverts to `user:{emailid}` and the recovered user
6544 # retains the role in the binding.
6545 #
6546 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6547 # unique identifier) representing a service account that has been recently
6548 # deleted. For example,
6549 # `[email protected]?uid=123456789012345678901`.
6550 # If the service account is undeleted, this value reverts to
6551 # `serviceAccount:{emailid}` and the undeleted service account retains the
6552 # role in the binding.
6553 #
6554 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6555 # identifier) representing a Google group that has been recently
6556 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6557 # the group is recovered, this value reverts to `group:{emailid}` and the
6558 # recovered group retains the role in the binding.
6559 #
6560 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6561 # Deleted single identity in a workforce identity pool. For example,
6562 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6563 &quot;A String&quot;,
6564 ],
6565 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6566 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6567 #
6568 # For an overview of the IAM roles and permissions, see the
6569 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6570 # a list of the available pre-defined roles, see
6571 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6572 },
6573 ],
6574 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6575 # prevent simultaneous updates of a policy from overwriting each other.
6576 # It is strongly suggested that systems make use of the `etag` in the
6577 # read-modify-write cycle to perform policy updates in order to avoid race
6578 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6579 # systems are expected to put that etag in the request to `setIamPolicy` to
6580 # ensure that their change will be applied to the same version of the policy.
6581 #
6582 # **Important:** If you use IAM Conditions, you must include the `etag` field
6583 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6584 # you to overwrite a version `3` policy with a version `1` policy, and all of
6585 # the conditions in the version `3` policy are lost.
6586 &quot;version&quot;: 42, # Specifies the format of the policy.
6587 #
6588 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6589 # are rejected.
6590 #
6591 # Any operation that affects conditional role bindings must specify version
6592 # `3`. This requirement applies to the following operations:
6593 #
6594 # * Getting a policy that includes a conditional role binding
6595 # * Adding a conditional role binding to a policy
6596 # * Changing a conditional role binding in a policy
6597 # * Removing any role binding, with or without a condition, from a policy
6598 # that includes conditions
6599 #
6600 # **Important:** If you use IAM Conditions, you must include the `etag` field
6601 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6602 # you to overwrite a version `3` policy with a version `1` policy, and all of
6603 # the conditions in the version `3` policy are lost.
6604 #
6605 # If a policy does not include any conditions, operations on that policy may
6606 # specify any valid version or leave the field unset.
6607 #
6608 # To learn which resources support conditions in their IAM policies, see the
6609 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6610 },
6611 }
6612
6613 x__xgafv: string, V1 error format.
6614 Allowed values
6615 1 - v1 error format
6616 2 - v2 error format
6617
6618 Returns:
6619 An object of the form:
6620
6621 { # An Identity and Access Management (IAM) policy, which specifies access
6622 # controls for Google Cloud resources.
6623 #
6624 #
6625 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
6626 # `members`, or principals, to a single `role`. Principals can be user
6627 # accounts, service accounts, Google groups, and domains (such as G Suite). A
6628 # `role` is a named list of permissions; each `role` can be an IAM predefined
6629 # role or a user-created custom role.
6630 #
6631 # For some types of Google Cloud resources, a `binding` can also specify a
6632 # `condition`, which is a logical expression that allows access to a resource
6633 # only if the expression evaluates to `true`. A condition can add constraints
6634 # based on attributes of the request, the resource, or both. To learn which
6635 # resources support conditions in their IAM policies, see the
6636 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6637 #
6638 # **JSON example:**
6639 #
6640 # ```
6641 # {
6642 # &quot;bindings&quot;: [
6643 # {
6644 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
6645 # &quot;members&quot;: [
6646 # &quot;user:[email protected]&quot;,
6647 # &quot;group:[email protected]&quot;,
6648 # &quot;domain:google.com&quot;,
6649 # &quot;serviceAccount:[email protected]&quot;
6650 # ]
6651 # },
6652 # {
6653 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
6654 # &quot;members&quot;: [
6655 # &quot;user:[email protected]&quot;
6656 # ],
6657 # &quot;condition&quot;: {
6658 # &quot;title&quot;: &quot;expirable access&quot;,
6659 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
6660 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
6661 # }
6662 # }
6663 # ],
6664 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
6665 # &quot;version&quot;: 3
6666 # }
6667 # ```
6668 #
6669 # **YAML example:**
6670 #
6671 # ```
6672 # bindings:
6673 # - members:
6674 # - user:[email protected]
6675 # - group:[email protected]
6676 # - domain:google.com
6677 # - serviceAccount:[email protected]
6678 # role: roles/resourcemanager.organizationAdmin
6679 # - members:
6680 # - user:[email protected]
6681 # role: roles/resourcemanager.organizationViewer
6682 # condition:
6683 # title: expirable access
6684 # description: Does not grant access after Sep 2020
6685 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
6686 # etag: BwWWja0YfJA=
6687 # version: 3
6688 # ```
6689 #
6690 # For a description of IAM and its features, see the
6691 # [IAM documentation](https://cloud.google.com/iam/docs/).
6692 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
6693 { # Specifies the audit configuration for a service.
6694 # The configuration determines which permission types are logged, and what
6695 # identities, if any, are exempted from logging.
6696 # An AuditConfig must have one or more AuditLogConfigs.
6697 #
6698 # If there are AuditConfigs for both `allServices` and a specific service,
6699 # the union of the two AuditConfigs is used for that service: the log_types
6700 # specified in each AuditConfig are enabled, and the exempted_members in each
6701 # AuditLogConfig are exempted.
6702 #
6703 # Example Policy with multiple AuditConfigs:
6704 #
6705 # {
6706 # &quot;audit_configs&quot;: [
6707 # {
6708 # &quot;service&quot;: &quot;allServices&quot;,
6709 # &quot;audit_log_configs&quot;: [
6710 # {
6711 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6712 # &quot;exempted_members&quot;: [
6713 # &quot;user:[email protected]&quot;
6714 # ]
6715 # },
6716 # {
6717 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6718 # },
6719 # {
6720 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
6721 # }
6722 # ]
6723 # },
6724 # {
6725 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
6726 # &quot;audit_log_configs&quot;: [
6727 # {
6728 # &quot;log_type&quot;: &quot;DATA_READ&quot;
6729 # },
6730 # {
6731 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
6732 # &quot;exempted_members&quot;: [
6733 # &quot;user:[email protected]&quot;
6734 # ]
6735 # }
6736 # ]
6737 # }
6738 # ]
6739 # }
6740 #
6741 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
6742 # logging. It also exempts `[email protected]` from DATA_READ logging, and
6743 # `[email protected]` from DATA_WRITE logging.
6744 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
6745 { # Provides the configuration for logging a type of permissions.
6746 # Example:
6747 #
6748 # {
6749 # &quot;audit_log_configs&quot;: [
6750 # {
6751 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6752 # &quot;exempted_members&quot;: [
6753 # &quot;user:[email protected]&quot;
6754 # ]
6755 # },
6756 # {
6757 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6758 # }
6759 # ]
6760 # }
6761 #
6762 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
6763 # [email protected] from DATA_READ logging.
6764 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
6765 # permission.
6766 # Follows the same format of Binding.members.
6767 &quot;A String&quot;,
6768 ],
6769 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
6770 },
6771 ],
6772 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
6773 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
6774 # `allServices` is a special value that covers all services.
6775 },
6776 ],
6777 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
6778 # may specify a `condition` that determines how and when the `bindings` are
6779 # applied. Each of the `bindings` must contain at least one principal.
6780 #
6781 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
6782 # of these principals can be Google groups. Each occurrence of a principal
6783 # counts towards these limits. For example, if the `bindings` grant 50
6784 # different roles to `user:[email protected]`, and not to any other
6785 # principal, then you can add another 1,450 principals to the `bindings` in
6786 # the `Policy`.
6787 { # Associates `members`, or principals, with a `role`.
6788 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6789 #
6790 # If the condition evaluates to `true`, then this binding applies to the
6791 # current request.
6792 #
6793 # If the condition evaluates to `false`, then this binding does not apply to
6794 # the current request. However, a different role binding might grant the same
6795 # role to one or more of the principals in this binding.
6796 #
6797 # To learn which resources support conditions in their IAM policies, see the
6798 # [IAM
6799 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6800 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6801 # are documented at https://github.com/google/cel-spec.
6802 #
6803 # Example (Comparison):
6804 #
6805 # title: &quot;Summary size limit&quot;
6806 # description: &quot;Determines if a summary is less than 100 chars&quot;
6807 # expression: &quot;document.summary.size() &lt; 100&quot;
6808 #
6809 # Example (Equality):
6810 #
6811 # title: &quot;Requestor is owner&quot;
6812 # description: &quot;Determines if requestor is the document owner&quot;
6813 # expression: &quot;document.owner == request.auth.claims.email&quot;
6814 #
6815 # Example (Logic):
6816 #
6817 # title: &quot;Public documents&quot;
6818 # description: &quot;Determine whether the document should be publicly visible&quot;
6819 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6820 #
6821 # Example (Data Manipulation):
6822 #
6823 # title: &quot;Notification string&quot;
6824 # description: &quot;Create a notification string with a timestamp.&quot;
6825 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6826 #
6827 # The exact variables and functions that may be referenced within an expression
6828 # are determined by the service that evaluates it. See the service
6829 # documentation for additional information.
6830 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6831 # describes the expression, e.g. when hovered over it in a UI.
6832 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6833 # syntax.
6834 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6835 # reporting, e.g. a file name and a position in the file.
6836 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6837 # its purpose. This can be used e.g. in UIs which allow to enter the
6838 # expression.
6839 },
6840 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6841 # `members` can have the following values:
6842 #
6843 # * `allUsers`: A special identifier that represents anyone who is
6844 # on the internet; with or without a Google account.
6845 #
6846 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6847 # who is authenticated with a Google account or a service account.
6848 # Does not include identities that come from external identity providers
6849 # (IdPs) through identity federation.
6850 #
6851 # * `user:{emailid}`: An email address that represents a specific Google
6852 # account. For example, `[email protected]` .
6853 #
6854 #
6855 # * `serviceAccount:{emailid}`: An email address that represents a Google
6856 # service account. For example,
6857 # `[email protected]`.
6858 #
6859 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6860 # identifier for a
6861 # [Kubernetes service
6862 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6863 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6864 #
6865 # * `group:{emailid}`: An email address that represents a Google group.
6866 # For example, `[email protected]`.
6867 #
6868 #
6869 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6870 # users of that domain. For example, `google.com` or `example.com`.
6871 #
6872 #
6873 #
6874 #
6875 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6876 # A single identity in a workforce identity pool.
6877 #
6878 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6879 # All workforce identities in a group.
6880 #
6881 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6882 # All workforce identities with a specific attribute value.
6883 #
6884 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6885 # All identities in a workforce identity pool.
6886 #
6887 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6888 # A single identity in a workload identity pool.
6889 #
6890 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6891 # A workload identity pool group.
6892 #
6893 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6894 # All identities in a workload identity pool with a certain attribute.
6895 #
6896 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6897 # All identities in a workload identity pool.
6898 #
6899 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6900 # identifier) representing a user that has been recently deleted. For
6901 # example, `[email protected]?uid=123456789012345678901`. If the user is
6902 # recovered, this value reverts to `user:{emailid}` and the recovered user
6903 # retains the role in the binding.
6904 #
6905 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6906 # unique identifier) representing a service account that has been recently
6907 # deleted. For example,
6908 # `[email protected]?uid=123456789012345678901`.
6909 # If the service account is undeleted, this value reverts to
6910 # `serviceAccount:{emailid}` and the undeleted service account retains the
6911 # role in the binding.
6912 #
6913 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6914 # identifier) representing a Google group that has been recently
6915 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6916 # the group is recovered, this value reverts to `group:{emailid}` and the
6917 # recovered group retains the role in the binding.
6918 #
6919 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6920 # Deleted single identity in a workforce identity pool. For example,
6921 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6922 &quot;A String&quot;,
6923 ],
6924 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6925 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6926 #
6927 # For an overview of the IAM roles and permissions, see the
6928 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6929 # a list of the available pre-defined roles, see
6930 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6931 },
6932 ],
6933 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6934 # prevent simultaneous updates of a policy from overwriting each other.
6935 # It is strongly suggested that systems make use of the `etag` in the
6936 # read-modify-write cycle to perform policy updates in order to avoid race
6937 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6938 # systems are expected to put that etag in the request to `setIamPolicy` to
6939 # ensure that their change will be applied to the same version of the policy.
6940 #
6941 # **Important:** If you use IAM Conditions, you must include the `etag` field
6942 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6943 # you to overwrite a version `3` policy with a version `1` policy, and all of
6944 # the conditions in the version `3` policy are lost.
6945 &quot;version&quot;: 42, # Specifies the format of the policy.
6946 #
6947 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6948 # are rejected.
6949 #
6950 # Any operation that affects conditional role bindings must specify version
6951 # `3`. This requirement applies to the following operations:
6952 #
6953 # * Getting a policy that includes a conditional role binding
6954 # * Adding a conditional role binding to a policy
6955 # * Changing a conditional role binding in a policy
6956 # * Removing any role binding, with or without a condition, from a policy
6957 # that includes conditions
6958 #
6959 # **Important:** If you use IAM Conditions, you must include the `etag` field
6960 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6961 # you to overwrite a version `3` policy with a version `1` policy, and all of
6962 # the conditions in the version `3` policy are lost.
6963 #
6964 # If a policy does not include any conditions, operations on that policy may
6965 # specify any valid version or leave the field unset.
6966 #
6967 # To learn which resources support conditions in their IAM policies, see the
6968 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6969 }</pre>
6970 </div>
6971
6972 <div class="method">
6973 <code class="details" id="setLabels">setLabels(project, zone, resource, body=None, requestId=None, x__xgafv=None)</code>
6974 <pre>Sets the labels on a disk. To learn more about labels, read theLabeling
6975 Resources documentation.
6976
6977 Args:
6978 project: string, Project ID for this request. (required)
6979 zone: string, The name of the zone for this request. (required)
6980 resource: string, Name or id of the resource for this request. (required)
6981 body: object, The request body.
6982 The object takes the form of:
6983
6984 {
6985 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
6986 # used to detect conflicts. The fingerprint is initially generated by Compute
6987 # Engine and changes after every request to modify or update labels. You must
6988 # always provide an up-to-date fingerprint hash in order to update or change
6989 # labels. Make a get() request to the resource to get the latest
6990 # fingerprint.
6991 &quot;labels&quot;: { # The labels to set for this resource.
6992 &quot;a_key&quot;: &quot;A String&quot;,
6993 },
6994 }
6995
6996 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6997 that if you must retry your request, the server will know to ignore the
6998 request if it has already been completed.
6999
7000 For example, consider a situation where you make an initial request and
7001 the request times out. If you make the request again with the same
7002 request ID, the server can check if original operation with the same
7003 request ID was received, and if so, will ignore the second request. This
7004 prevents clients from accidentally creating duplicate commitments.
7005
7006 The request ID must be
7007 a valid UUID with the exception that zero UUID is not supported
7008 (00000000-0000-0000-0000-000000000000).
7009 x__xgafv: string, V1 error format.
7010 Allowed values
7011 1 - v1 error format
7012 2 - v2 error format
7013
7014 Returns:
7015 An object of the form:
7016
7017 { # Represents an Operation resource.
7018 #
7019 # Google Compute Engine has three Operation resources:
7020 #
7021 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7022 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7023 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7024 #
7025 # You can use an operation resource to manage asynchronous API requests.
7026 # For more information, readHandling
7027 # API responses.
7028 #
7029 # Operations can be global, regional or zonal.
7030 #
7031 # - For global operations, use the `globalOperations`
7032 # resource.
7033 # - For regional operations, use the
7034 # `regionOperations` resource.
7035 # - For zonal operations, use
7036 # the `zoneOperations` resource.
7037 #
7038 #
7039 #
7040 # For more information, read
7041 # Global, Regional, and Zonal Resources.
7042 #
7043 # Note that completed Operation resources have a limited
7044 # retention period.
7045 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7046 # Not present otherwise.
7047 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7048 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7049 # set when the operation is created.
7050 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7051 # text format.
7052 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7053 # this field will be populated.
7054 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7055 # operation.
7056 {
7057 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7058 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7059 # details. There is a set of defined message types to use for providing
7060 # details.The syntax depends on the error code. For example,
7061 # QuotaExceededInfo will have details when the error code is
7062 # QUOTA_EXCEEDED.
7063 {
7064 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7065 #
7066 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7067 # is not enabled:
7068 #
7069 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7070 # &quot;domain&quot;: &quot;googleapis.com&quot;
7071 # &quot;metadata&quot;: {
7072 # &quot;resource&quot;: &quot;projects/123&quot;,
7073 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7074 # }
7075 # }
7076 #
7077 # This response indicates that the pubsub.googleapis.com API is not enabled.
7078 #
7079 # Example of an error that is returned when attempting to create a Spanner
7080 # instance in a region that is out of stock:
7081 #
7082 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7083 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7084 # &quot;metadata&quot;: {
7085 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7086 # }
7087 # }
7088 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7089 # is typically the registered service name of the tool or product that
7090 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7091 # generated by some common infrastructure, the error domain must be a
7092 # globally unique value that identifies the infrastructure. For Google API
7093 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7094 &quot;metadatas&quot;: { # Additional structured details about this error.
7095 #
7096 # Keys must match a regular expression of `a-z+` but should
7097 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7098 # length. When identifying the current value of an exceeded limit, the units
7099 # should be contained in the key, not the value. For example, rather than
7100 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7101 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7102 # instances that can be created in a single (batch) request.
7103 &quot;a_key&quot;: &quot;A String&quot;,
7104 },
7105 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7106 # proximate cause of the error. Error reasons are unique within a particular
7107 # domain of errors. This should be at most 63 characters and match a
7108 # regular expression of `A-Z+[A-Z0-9]`, which represents
7109 # UPPER_SNAKE_CASE.
7110 },
7111 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7112 #
7113 # For example, if a quota check failed with an error indicating the calling
7114 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7115 # directly to the right place in the developer console to flip the bit.
7116 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7117 { # Describes a URL link.
7118 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7119 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7120 },
7121 ],
7122 },
7123 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7124 # which can be attached to an RPC error.
7125 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7126 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7127 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7128 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7129 },
7130 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7131 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7132 &quot;a_key&quot;: &quot;A String&quot;,
7133 },
7134 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7135 # type or metric.
7136 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7137 # or metric.
7138 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7139 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7140 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7141 },
7142 },
7143 ],
7144 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7145 # This property is optional.
7146 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7147 },
7148 ],
7149 },
7150 &quot;getVersionOperationMetadata&quot;: {
7151 &quot;inlineSbomInfo&quot;: {
7152 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7153 # appropriate identifiers.
7154 &quot;a_key&quot;: &quot;A String&quot;,
7155 },
7156 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7157 # identifiers.
7158 &quot;a_key&quot;: &quot;A String&quot;,
7159 },
7160 },
7161 },
7162 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7163 # message that was returned, such as `NOT FOUND`.
7164 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7165 # status code that was returned. For example, a `404` means the
7166 # resource was not found.
7167 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7168 # defined by the server.
7169 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7170 # This value is inRFC3339
7171 # text format.
7172 &quot;instancesBulkInsertOperationMetadata&quot;: {
7173 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7174 # Example key: zones/us-central1-a
7175 &quot;a_key&quot;: {
7176 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7177 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7178 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7179 # error.
7180 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7181 # if the flow is rolling forward or rolling back.
7182 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7183 },
7184 },
7185 },
7186 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7187 # Operation resources.
7188 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7189 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7190 # group of operations results from a `bulkInsert` API request.
7191 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7192 # `update`, or `delete`, and so on.
7193 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7194 # There is no requirement that this be linear or support any granularity of
7195 # operations. This should not be used to guess when the operation will be
7196 # complete. This number should monotonically increase as the operation
7197 # progresses.
7198 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7199 # applicable when performing regional operations.
7200 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7201 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7202 # this field will contain information on all underlying zonal actions and
7203 # their state.
7204 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7205 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7206 # Example key: zones/us-central1-a
7207 &quot;a_key&quot;: {
7208 &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
7209 # populated.
7210 # different programming environments, including REST APIs and RPC APIs. It is
7211 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7212 # three pieces of data: error code, error message, and error details.
7213 #
7214 # You can find out more about this error model and how to work with it in the
7215 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7216 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7217 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7218 # message types for APIs to use.
7219 {
7220 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7221 },
7222 ],
7223 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7224 # user-facing error message should be localized and sent in the
7225 # google.rpc.Status.details field, or localized by the client.
7226 },
7227 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7228 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7229 },
7230 },
7231 },
7232 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7233 # This value is inRFC3339
7234 # text format.
7235 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7236 # following:
7237 # `PENDING`, `RUNNING`, or `DONE`.
7238 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7239 # operation.
7240 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7241 # of the target resource.
7242 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7243 # operations related to creating a snapshot, this points to the disk
7244 # that the snapshot was created from.
7245 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7246 # `[email protected]` or
7247 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7248 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7249 # operation, this field will be populated.
7250 {
7251 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7252 # Engine returns NO_RESULTS_ON_PAGE if there
7253 # are no results in the response.
7254 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7255 # value format. For example:
7256 #
7257 # &quot;data&quot;: [
7258 # {
7259 # &quot;key&quot;: &quot;scope&quot;,
7260 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7261 # }
7262 {
7263 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7264 # returned. For example, for warnings where there are no results in a list
7265 # request for a particular zone, this key might be scope and
7266 # the key value might be the zone name. Other examples might be a key
7267 # indicating a deprecated resource and a suggested replacement, or a
7268 # warning about invalid network settings (for example, if an instance
7269 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7270 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7271 },
7272 ],
7273 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7274 },
7275 ],
7276 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7277 # applicable when performing per-zone operations.
7278 }</pre>
7279 </div>
7280
7281 <div class="method">
7282 <code class="details" id="startAsyncReplication">startAsyncReplication(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
7283 <pre>Starts asynchronous replication.
7284 Must be invoked on the primary disk.
7285
7286 Args:
7287 project: string, Project ID for this request. (required)
7288 zone: string, The name of the zone for this request. (required)
7289 disk: string, The name of the persistent disk. (required)
7290 body: object, The request body.
7291 The object takes the form of:
7292
7293 {
7294 &quot;asyncSecondaryDisk&quot;: &quot;A String&quot;, # The secondary disk to start asynchronous replication to.
7295 # You can provide this as a partial or full URL to the resource. For example,
7296 # the following are valid values:
7297 #
7298 #
7299 # -
7300 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
7301 #
7302 # -
7303 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
7304 #
7305 # -
7306 # projects/project/zones/zone/disks/disk
7307 #
7308 # -
7309 # projects/project/regions/region/disks/disk
7310 #
7311 # -
7312 # zones/zone/disks/disk
7313 #
7314 # -
7315 # regions/region/disks/disk
7316 }
7317
7318 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7319 that if you must retry your request, the server will know to ignore the
7320 request if it has already been completed.
7321
7322 For example, consider a situation where you make an initial request and
7323 the request times out. If you make the request again with the same
7324 request ID, the server can check if original operation with the same
7325 request ID was received, and if so, will ignore the second request. This
7326 prevents clients from accidentally creating duplicate commitments.
7327
7328 The request ID must be
7329 a valid UUID with the exception that zero UUID is not supported
7330 (00000000-0000-0000-0000-000000000000).
7331 x__xgafv: string, V1 error format.
7332 Allowed values
7333 1 - v1 error format
7334 2 - v2 error format
7335
7336 Returns:
7337 An object of the form:
7338
7339 { # Represents an Operation resource.
7340 #
7341 # Google Compute Engine has three Operation resources:
7342 #
7343 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7344 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7345 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7346 #
7347 # You can use an operation resource to manage asynchronous API requests.
7348 # For more information, readHandling
7349 # API responses.
7350 #
7351 # Operations can be global, regional or zonal.
7352 #
7353 # - For global operations, use the `globalOperations`
7354 # resource.
7355 # - For regional operations, use the
7356 # `regionOperations` resource.
7357 # - For zonal operations, use
7358 # the `zoneOperations` resource.
7359 #
7360 #
7361 #
7362 # For more information, read
7363 # Global, Regional, and Zonal Resources.
7364 #
7365 # Note that completed Operation resources have a limited
7366 # retention period.
7367 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7368 # Not present otherwise.
7369 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7370 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7371 # set when the operation is created.
7372 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7373 # text format.
7374 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7375 # this field will be populated.
7376 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7377 # operation.
7378 {
7379 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7380 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7381 # details. There is a set of defined message types to use for providing
7382 # details.The syntax depends on the error code. For example,
7383 # QuotaExceededInfo will have details when the error code is
7384 # QUOTA_EXCEEDED.
7385 {
7386 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7387 #
7388 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7389 # is not enabled:
7390 #
7391 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7392 # &quot;domain&quot;: &quot;googleapis.com&quot;
7393 # &quot;metadata&quot;: {
7394 # &quot;resource&quot;: &quot;projects/123&quot;,
7395 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7396 # }
7397 # }
7398 #
7399 # This response indicates that the pubsub.googleapis.com API is not enabled.
7400 #
7401 # Example of an error that is returned when attempting to create a Spanner
7402 # instance in a region that is out of stock:
7403 #
7404 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7405 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7406 # &quot;metadata&quot;: {
7407 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7408 # }
7409 # }
7410 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7411 # is typically the registered service name of the tool or product that
7412 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7413 # generated by some common infrastructure, the error domain must be a
7414 # globally unique value that identifies the infrastructure. For Google API
7415 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7416 &quot;metadatas&quot;: { # Additional structured details about this error.
7417 #
7418 # Keys must match a regular expression of `a-z+` but should
7419 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7420 # length. When identifying the current value of an exceeded limit, the units
7421 # should be contained in the key, not the value. For example, rather than
7422 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7423 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7424 # instances that can be created in a single (batch) request.
7425 &quot;a_key&quot;: &quot;A String&quot;,
7426 },
7427 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7428 # proximate cause of the error. Error reasons are unique within a particular
7429 # domain of errors. This should be at most 63 characters and match a
7430 # regular expression of `A-Z+[A-Z0-9]`, which represents
7431 # UPPER_SNAKE_CASE.
7432 },
7433 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7434 #
7435 # For example, if a quota check failed with an error indicating the calling
7436 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7437 # directly to the right place in the developer console to flip the bit.
7438 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7439 { # Describes a URL link.
7440 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7441 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7442 },
7443 ],
7444 },
7445 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7446 # which can be attached to an RPC error.
7447 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7448 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7449 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7450 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7451 },
7452 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7453 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7454 &quot;a_key&quot;: &quot;A String&quot;,
7455 },
7456 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7457 # type or metric.
7458 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7459 # or metric.
7460 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7461 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7462 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7463 },
7464 },
7465 ],
7466 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7467 # This property is optional.
7468 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7469 },
7470 ],
7471 },
7472 &quot;getVersionOperationMetadata&quot;: {
7473 &quot;inlineSbomInfo&quot;: {
7474 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7475 # appropriate identifiers.
7476 &quot;a_key&quot;: &quot;A String&quot;,
7477 },
7478 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7479 # identifiers.
7480 &quot;a_key&quot;: &quot;A String&quot;,
7481 },
7482 },
7483 },
7484 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7485 # message that was returned, such as `NOT FOUND`.
7486 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7487 # status code that was returned. For example, a `404` means the
7488 # resource was not found.
7489 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7490 # defined by the server.
7491 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7492 # This value is inRFC3339
7493 # text format.
7494 &quot;instancesBulkInsertOperationMetadata&quot;: {
7495 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7496 # Example key: zones/us-central1-a
7497 &quot;a_key&quot;: {
7498 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7499 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7500 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7501 # error.
7502 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7503 # if the flow is rolling forward or rolling back.
7504 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7505 },
7506 },
7507 },
7508 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7509 # Operation resources.
7510 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7511 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7512 # group of operations results from a `bulkInsert` API request.
7513 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7514 # `update`, or `delete`, and so on.
7515 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7516 # There is no requirement that this be linear or support any granularity of
7517 # operations. This should not be used to guess when the operation will be
7518 # complete. This number should monotonically increase as the operation
7519 # progresses.
7520 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7521 # applicable when performing regional operations.
7522 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7523 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7524 # this field will contain information on all underlying zonal actions and
7525 # their state.
7526 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7527 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7528 # Example key: zones/us-central1-a
7529 &quot;a_key&quot;: {
7530 &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
7531 # populated.
7532 # different programming environments, including REST APIs and RPC APIs. It is
7533 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7534 # three pieces of data: error code, error message, and error details.
7535 #
7536 # You can find out more about this error model and how to work with it in the
7537 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7538 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7539 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7540 # message types for APIs to use.
7541 {
7542 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7543 },
7544 ],
7545 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7546 # user-facing error message should be localized and sent in the
7547 # google.rpc.Status.details field, or localized by the client.
7548 },
7549 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7550 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7551 },
7552 },
7553 },
7554 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7555 # This value is inRFC3339
7556 # text format.
7557 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7558 # following:
7559 # `PENDING`, `RUNNING`, or `DONE`.
7560 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7561 # operation.
7562 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7563 # of the target resource.
7564 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7565 # operations related to creating a snapshot, this points to the disk
7566 # that the snapshot was created from.
7567 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7568 # `[email protected]` or
7569 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7570 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7571 # operation, this field will be populated.
7572 {
7573 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7574 # Engine returns NO_RESULTS_ON_PAGE if there
7575 # are no results in the response.
7576 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7577 # value format. For example:
7578 #
7579 # &quot;data&quot;: [
7580 # {
7581 # &quot;key&quot;: &quot;scope&quot;,
7582 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7583 # }
7584 {
7585 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7586 # returned. For example, for warnings where there are no results in a list
7587 # request for a particular zone, this key might be scope and
7588 # the key value might be the zone name. Other examples might be a key
7589 # indicating a deprecated resource and a suggested replacement, or a
7590 # warning about invalid network settings (for example, if an instance
7591 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7592 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7593 },
7594 ],
7595 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7596 },
7597 ],
7598 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7599 # applicable when performing per-zone operations.
7600 }</pre>
7601 </div>
7602
7603 <div class="method">
7604 <code class="details" id="stopAsyncReplication">stopAsyncReplication(project, zone, disk, requestId=None, x__xgafv=None)</code>
7605 <pre>Stops asynchronous replication.
7606 Can be invoked either on the primary or on the secondary disk.
7607
7608 Args:
7609 project: string, Project ID for this request. (required)
7610 zone: string, The name of the zone for this request. (required)
7611 disk: string, The name of the persistent disk. (required)
7612 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7613 that if you must retry your request, the server will know to ignore the
7614 request if it has already been completed.
7615
7616 For example, consider a situation where you make an initial request and
7617 the request times out. If you make the request again with the same
7618 request ID, the server can check if original operation with the same
7619 request ID was received, and if so, will ignore the second request. This
7620 prevents clients from accidentally creating duplicate commitments.
7621
7622 The request ID must be
7623 a valid UUID with the exception that zero UUID is not supported
7624 (00000000-0000-0000-0000-000000000000).
7625 x__xgafv: string, V1 error format.
7626 Allowed values
7627 1 - v1 error format
7628 2 - v2 error format
7629
7630 Returns:
7631 An object of the form:
7632
7633 { # Represents an Operation resource.
7634 #
7635 # Google Compute Engine has three Operation resources:
7636 #
7637 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7638 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7639 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7640 #
7641 # You can use an operation resource to manage asynchronous API requests.
7642 # For more information, readHandling
7643 # API responses.
7644 #
7645 # Operations can be global, regional or zonal.
7646 #
7647 # - For global operations, use the `globalOperations`
7648 # resource.
7649 # - For regional operations, use the
7650 # `regionOperations` resource.
7651 # - For zonal operations, use
7652 # the `zoneOperations` resource.
7653 #
7654 #
7655 #
7656 # For more information, read
7657 # Global, Regional, and Zonal Resources.
7658 #
7659 # Note that completed Operation resources have a limited
7660 # retention period.
7661 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7662 # Not present otherwise.
7663 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7664 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7665 # set when the operation is created.
7666 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7667 # text format.
7668 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7669 # this field will be populated.
7670 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7671 # operation.
7672 {
7673 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7674 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7675 # details. There is a set of defined message types to use for providing
7676 # details.The syntax depends on the error code. For example,
7677 # QuotaExceededInfo will have details when the error code is
7678 # QUOTA_EXCEEDED.
7679 {
7680 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7681 #
7682 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7683 # is not enabled:
7684 #
7685 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7686 # &quot;domain&quot;: &quot;googleapis.com&quot;
7687 # &quot;metadata&quot;: {
7688 # &quot;resource&quot;: &quot;projects/123&quot;,
7689 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7690 # }
7691 # }
7692 #
7693 # This response indicates that the pubsub.googleapis.com API is not enabled.
7694 #
7695 # Example of an error that is returned when attempting to create a Spanner
7696 # instance in a region that is out of stock:
7697 #
7698 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7699 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7700 # &quot;metadata&quot;: {
7701 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7702 # }
7703 # }
7704 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7705 # is typically the registered service name of the tool or product that
7706 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7707 # generated by some common infrastructure, the error domain must be a
7708 # globally unique value that identifies the infrastructure. For Google API
7709 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7710 &quot;metadatas&quot;: { # Additional structured details about this error.
7711 #
7712 # Keys must match a regular expression of `a-z+` but should
7713 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7714 # length. When identifying the current value of an exceeded limit, the units
7715 # should be contained in the key, not the value. For example, rather than
7716 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7717 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7718 # instances that can be created in a single (batch) request.
7719 &quot;a_key&quot;: &quot;A String&quot;,
7720 },
7721 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7722 # proximate cause of the error. Error reasons are unique within a particular
7723 # domain of errors. This should be at most 63 characters and match a
7724 # regular expression of `A-Z+[A-Z0-9]`, which represents
7725 # UPPER_SNAKE_CASE.
7726 },
7727 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7728 #
7729 # For example, if a quota check failed with an error indicating the calling
7730 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7731 # directly to the right place in the developer console to flip the bit.
7732 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7733 { # Describes a URL link.
7734 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7735 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7736 },
7737 ],
7738 },
7739 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7740 # which can be attached to an RPC error.
7741 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7742 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7743 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7744 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7745 },
7746 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7747 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7748 &quot;a_key&quot;: &quot;A String&quot;,
7749 },
7750 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7751 # type or metric.
7752 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7753 # or metric.
7754 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7755 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7756 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7757 },
7758 },
7759 ],
7760 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7761 # This property is optional.
7762 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7763 },
7764 ],
7765 },
7766 &quot;getVersionOperationMetadata&quot;: {
7767 &quot;inlineSbomInfo&quot;: {
7768 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7769 # appropriate identifiers.
7770 &quot;a_key&quot;: &quot;A String&quot;,
7771 },
7772 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7773 # identifiers.
7774 &quot;a_key&quot;: &quot;A String&quot;,
7775 },
7776 },
7777 },
7778 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7779 # message that was returned, such as `NOT FOUND`.
7780 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7781 # status code that was returned. For example, a `404` means the
7782 # resource was not found.
7783 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7784 # defined by the server.
7785 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7786 # This value is inRFC3339
7787 # text format.
7788 &quot;instancesBulkInsertOperationMetadata&quot;: {
7789 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7790 # Example key: zones/us-central1-a
7791 &quot;a_key&quot;: {
7792 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7793 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7794 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7795 # error.
7796 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7797 # if the flow is rolling forward or rolling back.
7798 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7799 },
7800 },
7801 },
7802 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7803 # Operation resources.
7804 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7805 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7806 # group of operations results from a `bulkInsert` API request.
7807 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7808 # `update`, or `delete`, and so on.
7809 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7810 # There is no requirement that this be linear or support any granularity of
7811 # operations. This should not be used to guess when the operation will be
7812 # complete. This number should monotonically increase as the operation
7813 # progresses.
7814 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7815 # applicable when performing regional operations.
7816 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7817 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7818 # this field will contain information on all underlying zonal actions and
7819 # their state.
7820 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7821 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7822 # Example key: zones/us-central1-a
7823 &quot;a_key&quot;: {
7824 &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
7825 # populated.
7826 # different programming environments, including REST APIs and RPC APIs. It is
7827 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7828 # three pieces of data: error code, error message, and error details.
7829 #
7830 # You can find out more about this error model and how to work with it in the
7831 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7832 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7833 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7834 # message types for APIs to use.
7835 {
7836 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7837 },
7838 ],
7839 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7840 # user-facing error message should be localized and sent in the
7841 # google.rpc.Status.details field, or localized by the client.
7842 },
7843 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7844 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7845 },
7846 },
7847 },
7848 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7849 # This value is inRFC3339
7850 # text format.
7851 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7852 # following:
7853 # `PENDING`, `RUNNING`, or `DONE`.
7854 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7855 # operation.
7856 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7857 # of the target resource.
7858 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7859 # operations related to creating a snapshot, this points to the disk
7860 # that the snapshot was created from.
7861 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7862 # `[email protected]` or
7863 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7864 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7865 # operation, this field will be populated.
7866 {
7867 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7868 # Engine returns NO_RESULTS_ON_PAGE if there
7869 # are no results in the response.
7870 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7871 # value format. For example:
7872 #
7873 # &quot;data&quot;: [
7874 # {
7875 # &quot;key&quot;: &quot;scope&quot;,
7876 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7877 # }
7878 {
7879 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7880 # returned. For example, for warnings where there are no results in a list
7881 # request for a particular zone, this key might be scope and
7882 # the key value might be the zone name. Other examples might be a key
7883 # indicating a deprecated resource and a suggested replacement, or a
7884 # warning about invalid network settings (for example, if an instance
7885 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7886 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7887 },
7888 ],
7889 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7890 },
7891 ],
7892 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7893 # applicable when performing per-zone operations.
7894 }</pre>
7895 </div>
7896
7897 <div class="method">
7898 <code class="details" id="stopGroupAsyncReplication">stopGroupAsyncReplication(project, zone, body=None, requestId=None, x__xgafv=None)</code>
7899 <pre>Stops asynchronous replication for a consistency group of disks.
7900 Can be invoked either in the primary or secondary scope.
7901
7902 Args:
7903 project: string, Project ID for this request. (required)
7904 zone: string, The name of the zone for this request. This must be the zone of the primary
7905 or secondary disks in the consistency group. (required)
7906 body: object, The request body.
7907 The object takes the form of:
7908
7909 { # A transient resource used in compute.disks.stopGroupAsyncReplication and
7910 # compute.regionDisks.stopGroupAsyncReplication. It is only used to process
7911 # requests and is not persisted.
7912 &quot;resourcePolicy&quot;: &quot;A String&quot;, # The URL of the DiskConsistencyGroupPolicy for the group of disks to stop.
7913 # This may be a full or partial URL, such as:
7914 #
7915 #
7916 # -
7917 # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
7918 #
7919 # -
7920 # projects/project/regions/region/resourcePolicies/resourcePolicy
7921 #
7922 # -
7923 # regions/region/resourcePolicies/resourcePolicy
7924 }
7925
7926 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7927 that if you must retry your request, the server will know to ignore the
7928 request if it has already been completed.
7929
7930 For example, consider a situation where you make an initial request and
7931 the request times out. If you make the request again with the same
7932 request ID, the server can check if original operation with the same
7933 request ID was received, and if so, will ignore the second request. This
7934 prevents clients from accidentally creating duplicate commitments.
7935
7936 The request ID must be
7937 a valid UUID with the exception that zero UUID is not supported
7938 (00000000-0000-0000-0000-000000000000).
7939 x__xgafv: string, V1 error format.
7940 Allowed values
7941 1 - v1 error format
7942 2 - v2 error format
7943
7944 Returns:
7945 An object of the form:
7946
7947 { # Represents an Operation resource.
7948 #
7949 # Google Compute Engine has three Operation resources:
7950 #
7951 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
7952 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
7953 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
7954 #
7955 # You can use an operation resource to manage asynchronous API requests.
7956 # For more information, readHandling
7957 # API responses.
7958 #
7959 # Operations can be global, regional or zonal.
7960 #
7961 # - For global operations, use the `globalOperations`
7962 # resource.
7963 # - For regional operations, use the
7964 # `regionOperations` resource.
7965 # - For zonal operations, use
7966 # the `zoneOperations` resource.
7967 #
7968 #
7969 #
7970 # For more information, read
7971 # Global, Regional, and Zonal Resources.
7972 #
7973 # Note that completed Operation resources have a limited
7974 # retention period.
7975 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7976 # Not present otherwise.
7977 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7978 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7979 # set when the operation is created.
7980 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7981 # text format.
7982 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7983 # this field will be populated.
7984 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7985 # operation.
7986 {
7987 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7988 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7989 # details. There is a set of defined message types to use for providing
7990 # details.The syntax depends on the error code. For example,
7991 # QuotaExceededInfo will have details when the error code is
7992 # QUOTA_EXCEEDED.
7993 {
7994 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7995 #
7996 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7997 # is not enabled:
7998 #
7999 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8000 # &quot;domain&quot;: &quot;googleapis.com&quot;
8001 # &quot;metadata&quot;: {
8002 # &quot;resource&quot;: &quot;projects/123&quot;,
8003 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8004 # }
8005 # }
8006 #
8007 # This response indicates that the pubsub.googleapis.com API is not enabled.
8008 #
8009 # Example of an error that is returned when attempting to create a Spanner
8010 # instance in a region that is out of stock:
8011 #
8012 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8013 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8014 # &quot;metadata&quot;: {
8015 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8016 # }
8017 # }
8018 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8019 # is typically the registered service name of the tool or product that
8020 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8021 # generated by some common infrastructure, the error domain must be a
8022 # globally unique value that identifies the infrastructure. For Google API
8023 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8024 &quot;metadatas&quot;: { # Additional structured details about this error.
8025 #
8026 # Keys must match a regular expression of `a-z+` but should
8027 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8028 # length. When identifying the current value of an exceeded limit, the units
8029 # should be contained in the key, not the value. For example, rather than
8030 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8031 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8032 # instances that can be created in a single (batch) request.
8033 &quot;a_key&quot;: &quot;A String&quot;,
8034 },
8035 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8036 # proximate cause of the error. Error reasons are unique within a particular
8037 # domain of errors. This should be at most 63 characters and match a
8038 # regular expression of `A-Z+[A-Z0-9]`, which represents
8039 # UPPER_SNAKE_CASE.
8040 },
8041 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8042 #
8043 # For example, if a quota check failed with an error indicating the calling
8044 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8045 # directly to the right place in the developer console to flip the bit.
8046 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8047 { # Describes a URL link.
8048 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8049 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8050 },
8051 ],
8052 },
8053 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8054 # which can be attached to an RPC error.
8055 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8056 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8057 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8058 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8059 },
8060 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8061 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8062 &quot;a_key&quot;: &quot;A String&quot;,
8063 },
8064 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8065 # type or metric.
8066 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8067 # or metric.
8068 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8069 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8070 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8071 },
8072 },
8073 ],
8074 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8075 # This property is optional.
8076 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8077 },
8078 ],
8079 },
8080 &quot;getVersionOperationMetadata&quot;: {
8081 &quot;inlineSbomInfo&quot;: {
8082 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8083 # appropriate identifiers.
8084 &quot;a_key&quot;: &quot;A String&quot;,
8085 },
8086 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8087 # identifiers.
8088 &quot;a_key&quot;: &quot;A String&quot;,
8089 },
8090 },
8091 },
8092 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8093 # message that was returned, such as `NOT FOUND`.
8094 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8095 # status code that was returned. For example, a `404` means the
8096 # resource was not found.
8097 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8098 # defined by the server.
8099 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8100 # This value is inRFC3339
8101 # text format.
8102 &quot;instancesBulkInsertOperationMetadata&quot;: {
8103 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8104 # Example key: zones/us-central1-a
8105 &quot;a_key&quot;: {
8106 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8107 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8108 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8109 # error.
8110 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8111 # if the flow is rolling forward or rolling back.
8112 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8113 },
8114 },
8115 },
8116 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8117 # Operation resources.
8118 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8119 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8120 # group of operations results from a `bulkInsert` API request.
8121 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8122 # `update`, or `delete`, and so on.
8123 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8124 # There is no requirement that this be linear or support any granularity of
8125 # operations. This should not be used to guess when the operation will be
8126 # complete. This number should monotonically increase as the operation
8127 # progresses.
8128 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8129 # applicable when performing regional operations.
8130 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8131 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8132 # this field will contain information on all underlying zonal actions and
8133 # their state.
8134 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8135 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8136 # Example key: zones/us-central1-a
8137 &quot;a_key&quot;: {
8138 &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
8139 # populated.
8140 # different programming environments, including REST APIs and RPC APIs. It is
8141 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8142 # three pieces of data: error code, error message, and error details.
8143 #
8144 # You can find out more about this error model and how to work with it in the
8145 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8146 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8147 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8148 # message types for APIs to use.
8149 {
8150 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8151 },
8152 ],
8153 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8154 # user-facing error message should be localized and sent in the
8155 # google.rpc.Status.details field, or localized by the client.
8156 },
8157 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8158 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8159 },
8160 },
8161 },
8162 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8163 # This value is inRFC3339
8164 # text format.
8165 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8166 # following:
8167 # `PENDING`, `RUNNING`, or `DONE`.
8168 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8169 # operation.
8170 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8171 # of the target resource.
8172 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8173 # operations related to creating a snapshot, this points to the disk
8174 # that the snapshot was created from.
8175 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8176 # `[email protected]` or
8177 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8178 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8179 # operation, this field will be populated.
8180 {
8181 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8182 # Engine returns NO_RESULTS_ON_PAGE if there
8183 # are no results in the response.
8184 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8185 # value format. For example:
8186 #
8187 # &quot;data&quot;: [
8188 # {
8189 # &quot;key&quot;: &quot;scope&quot;,
8190 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8191 # }
8192 {
8193 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8194 # returned. For example, for warnings where there are no results in a list
8195 # request for a particular zone, this key might be scope and
8196 # the key value might be the zone name. Other examples might be a key
8197 # indicating a deprecated resource and a suggested replacement, or a
8198 # warning about invalid network settings (for example, if an instance
8199 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8200 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8201 },
8202 ],
8203 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8204 },
8205 ],
8206 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8207 # applicable when performing per-zone operations.
8208 }</pre>
8209 </div>
8210
8211 <div class="method">
8212 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
8213 <pre>Returns permissions that a caller has on the specified resource.
8214
8215 Args:
8216 project: string, Project ID for this request. (required)
8217 zone: string, The name of the zone for this request. (required)
8218 resource: string, Name or id of the resource for this request. (required)
8219 body: object, The request body.
8220 The object takes the form of:
8221
8222 {
8223 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
8224 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
8225 &quot;A String&quot;,
8226 ],
8227 }
8228
8229 x__xgafv: string, V1 error format.
8230 Allowed values
8231 1 - v1 error format
8232 2 - v2 error format
8233
8234 Returns:
8235 An object of the form:
8236
8237 {
8238 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
8239 # allowed.
8240 &quot;A String&quot;,
8241 ],
8242 }</pre>
8243 </div>
8244
8245 <div class="method">
8246 <code class="details" id="update">update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>
8247 <pre>Updates the specified disk with the data included in the request.
8248 The update is performed only on selected fields included as part
8249 of update-mask.
8250
8251 Args:
8252 project: string, Project ID for this request. (required)
8253 zone: string, The name of the zone for this request. (required)
8254 disk: string, The disk name for this request. (required)
8255 body: object, The request body.
8256 The object takes the form of:
8257
8258 { # Represents a Persistent Disk resource.
8259 #
8260 # Google Compute Engine has two Disk resources:
8261 #
8262 # * [Zonal](/compute/docs/reference/rest/beta/disks)
8263 # * [Regional](/compute/docs/reference/rest/beta/regionDisks)
8264 #
8265 # Persistent disks are required for running your VM instances.
8266 # Create both boot and non-boot (data) persistent disks. For more information,
8267 # read Persistent Disks. For more
8268 # storage options, read Storage options.
8269 #
8270 # The disks resource represents a zonal persistent disk.
8271 # For more information, readZonal persistent disks.
8272 #
8273 # The regionDisks resource represents a
8274 # regional persistent disk. For more information, read
8275 # Regional resources.
8276 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
8277 #
8278 #
8279 # - READ_WRITE_SINGLE: The default AccessMode, means the
8280 # disk can be attached to single instance in RW mode.
8281 # - READ_WRITE_MANY: The AccessMode means the disk can be
8282 # attached to multiple instances in RW mode.
8283 # - READ_ONLY_MANY: The AccessMode means the disk can be
8284 # attached to multiple instances in RO mode.
8285 #
8286 #
8287 # The AccessMode is only valid for Hyperdisk disk types.
8288 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
8289 # ARM64 or X86_64.
8290 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
8291 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
8292 # started on the disk as a member of a group.
8293 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
8294 # started on the disk as a member of a group.
8295 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
8296 # You can provide this as a partial or full URL to the resource.
8297 # For example, the following are valid values:
8298 #
8299 #
8300 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
8301 # - projects/project/zones/zone/disks/disk
8302 # - zones/zone/disks/disk
8303 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
8304 # to or from the current disk. This value identifies the exact disk that
8305 # was used to create this replication. For example, if you started
8306 # replicating the persistent disk from a disk that was later deleted and
8307 # recreated under the same name, the disk ID would identify the exact
8308 # version of the disk that was used.
8309 },
8310 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
8311 &quot;a_key&quot;: {
8312 &quot;asyncReplicationDisk&quot;: {
8313 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
8314 # started on the disk as a member of a group.
8315 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
8316 # started on the disk as a member of a group.
8317 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
8318 # You can provide this as a partial or full URL to the resource.
8319 # For example, the following are valid values:
8320 #
8321 #
8322 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
8323 # - projects/project/zones/zone/disks/disk
8324 # - zones/zone/disks/disk
8325 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
8326 # to or from the current disk. This value identifies the exact disk that
8327 # was used to create this replication. For example, if you started
8328 # replicating the persistent disk from a disk that was later deleted and
8329 # recreated under the same name, the disk ID would identify the exact
8330 # version of the disk that was used.
8331 },
8332 },
8333 },
8334 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
8335 # text format.
8336 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
8337 # create the resource.
8338 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
8339 # customer-supplied encryption key or a
8340 # customer-managed encryption key.
8341 #
8342 # Encryption keys do not protect access to metadata of the disk.
8343 #
8344 # After you encrypt a disk with a customer-supplied key, you must provide the
8345 # same key if you use the disk later. For example, to create a disk snapshot,
8346 # to create a disk image, to create a machine image, or to attach the disk to
8347 # a virtual machine.
8348 #
8349 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
8350 # name once the disk is created. The disk is encrypted with this version of
8351 # the key. In the response, diskEncryptionKey.kmsKeyName appears
8352 # in the following format:
8353 #
8354 # &quot;diskEncryptionKey.kmsKeyName&quot;:
8355 # &quot;projects/kms_project_id/locations/region/keyRings/
8356 # key_region/cryptoKeys/key
8357 # /cryptoKeysVersions/version
8358 #
8359 # If you do not provide an encryption key when creating the disk, then the
8360 # disk is encrypted using an automatically generated key and you don&#x27;t need
8361 # to provide a key to use the disk later.
8362 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8363 # For example:
8364 #
8365 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8366 # key_region/cryptoKeys/key
8367 #
8368 # The fully-qualifed key name may be returned for resource GET requests. For
8369 # example:
8370 #
8371 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8372 # key_region/cryptoKeys/key
8373 # /cryptoKeyVersions/1
8374 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8375 # key. If absent, the Compute Engine default service account is used.
8376 # For example:
8377 #
8378 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8379 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8380 # encryption key, encoded in RFC
8381 # 4648 base64 to either encrypt or decrypt this resource. You can
8382 # provide either the rawKey or thersaEncryptedKey.
8383 # For example:
8384 #
8385 # &quot;rawKey&quot;:
8386 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8387 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8388 # customer-supplied encryption key to either encrypt or decrypt this
8389 # resource. You can provide either the rawKey or thersaEncryptedKey.
8390 # For example:
8391 #
8392 # &quot;rsaEncryptedKey&quot;:
8393 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8394 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8395 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8396 #
8397 # The key must meet the following requirements before you can provide it to
8398 # Compute Engine:
8399 #
8400 # 1. The key is wrapped using a RSA public key certificate provided by
8401 # Google.
8402 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8403 # encoding.
8404 #
8405 # Gets the RSA public key certificate provided by Google at:
8406 #
8407 #
8408 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8409 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8410 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8411 # encryption key that protects this resource.
8412 },
8413 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
8414 &quot;eraseWindowsVssSignature&quot;: True or False, # Specifies whether the disk restored from a source snapshot should erase
8415 # Windows specific VSS signature.
8416 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
8417 # only for bootable images. Read
8418 # Enabling guest operating system features to see a list of available
8419 # options.
8420 { # Guest OS features.
8421 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
8422 # separate values. Set to one or more of the following values:
8423 #
8424 # - VIRTIO_SCSI_MULTIQUEUE
8425 # - WINDOWS
8426 # - MULTI_IP_SUBNET
8427 # - UEFI_COMPATIBLE
8428 # - GVNIC
8429 # - SEV_CAPABLE
8430 # - SUSPEND_RESUME_COMPATIBLE
8431 # - SEV_LIVE_MIGRATABLE_V2
8432 # - SEV_SNP_CAPABLE
8433 # - TDX_CAPABLE
8434 # - IDPF
8435 # - SNP_SVSM_CAPABLE
8436 # - CCA_CAPABLE
8437 #
8438 #
8439 # For more information, see
8440 # Enabling guest operating system features.
8441 },
8442 ],
8443 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
8444 # defined by the server.
8445 &quot;interface&quot;: &quot;A String&quot;, # [Deprecated] Specifies the disk interface to use for attaching this disk,
8446 # which is either SCSI or NVME. The default isSCSI.
8447 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
8448 # disks.
8449 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
8450 # essentially a hash of the labels set used for optimistic locking. The
8451 # fingerprint is initially generated by Compute Engine and changes after
8452 # every request to modify or update labels. You must always provide an
8453 # up-to-date fingerprint hash in order to update or change labels,
8454 # otherwise the request will fail with error412 conditionNotMet.
8455 #
8456 # To see the latest fingerprint, make a get() request to
8457 # retrieve a disk.
8458 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
8459 # the setLabels method.
8460 &quot;a_key&quot;: &quot;A String&quot;,
8461 },
8462 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
8463 # text format.
8464 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
8465 # text format.
8466 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
8467 &quot;A String&quot;,
8468 ],
8469 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
8470 &quot;A String&quot;,
8471 ],
8472 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
8473 # This field is for use by internal tools that use the public API.
8474 &quot;locked&quot;: True or False, # Output only. [Output Only] The field indicates if the disk is created from a locked
8475 # source image. Attachment of a disk created from a locked source image will
8476 # cause the following operations to become irreversibly prohibited:
8477 #
8478 # - R/W or R/O disk attachment to any other instance
8479 # - Disk detachment. And the disk can only be deleted when the instance
8480 # is deleted
8481 # - Creation of images or snapshots
8482 # - Disk cloning
8483 #
8484 #
8485 #
8486 # Furthermore, the instance with at least one disk with locked flag set to
8487 # true will be prohibited from performing the operations below:
8488 #
8489 # - Further attachment of secondary disks.
8490 # - Detachment of any disks
8491 # - Create machine images
8492 # - Create instance template
8493 # - Delete the instance with --keep-disk parameter set to true for locked
8494 # disks
8495 # - Attach a locked disk with --auto-delete parameter set to false
8496 &quot;multiWriter&quot;: True or False, # Indicates whether or not the disk can be read/write attached to
8497 # more than one instance.
8498 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8499 # The name must be 1-63 characters long, and comply withRFC1035.
8500 # Specifically, the name must be 1-63 characters long and match the regular
8501 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
8502 # which means the first character must be a lowercase letter, and all
8503 # following characters must be a dash, lowercase letter, or digit, except
8504 # the last character, which cannot be a dash.
8505 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
8506 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
8507 # as part of resource payload.
8508 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
8509 # have the same definition as resource
8510 # manager tags. Keys and values can be either in numeric format,
8511 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
8512 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
8513 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
8514 # PATCH) when empty.
8515 &quot;a_key&quot;: &quot;A String&quot;,
8516 },
8517 },
8518 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
8519 # If not present in a request, a default value is used.
8520 # The currently supported size is 4096, other sizes may be added in
8521 # the future.
8522 # If an unsupported value is requested, the error message will list
8523 # the supported values for the caller&#x27;s project.
8524 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
8525 # of I/O operations per second that the disk can handle. Values must be
8526 # between 10,000 and 120,000. For more details, see theExtreme persistent
8527 # disk documentation.
8528 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
8529 # number of throughput mb per second that the disk can handle. Values must be
8530 # greater than or equal to 1.
8531 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
8532 # regional resources.
8533 # You must specify this field as part of the HTTP request URL. It is
8534 # not settable as a field in the request body.
8535 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
8536 # for regional resources.
8537 &quot;A String&quot;,
8538 ],
8539 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
8540 &quot;A String&quot;,
8541 ],
8542 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
8543 &quot;asyncPrimaryDisk&quot;: {
8544 &quot;state&quot;: &quot;A String&quot;,
8545 },
8546 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
8547 &quot;a_key&quot;: {
8548 &quot;state&quot;: &quot;A String&quot;,
8549 },
8550 },
8551 },
8552 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
8553 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
8554 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
8555 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
8556 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
8557 # persistent disk.
8558 #
8559 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
8560 # source.
8561 # Acceptable values are greater than 0.
8562 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
8563 # that was created using a consistency group.
8564 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
8565 # that was created using a consistency group.
8566 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
8567 # partial or full URL to the resource. For example, the following are valid
8568 # values:
8569 #
8570 #
8571 # -
8572 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
8573 #
8574 # -
8575 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
8576 #
8577 # -
8578 # projects/project/zones/zone/disks/disk
8579 #
8580 # -
8581 # projects/project/regions/region/disks/disk
8582 #
8583 # -
8584 # zones/zone/disks/disk
8585 #
8586 # -
8587 # regions/region/disks/disk
8588 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
8589 # value identifies the exact disk that was used to create this persistent
8590 # disk. For example, if you created the persistent disk from a disk that
8591 # was later deleted and recreated under the same name, the source disk ID
8592 # would identify the exact version of the disk that was used.
8593 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
8594 # deleted, this field will not be set.
8595 #
8596 # To create a disk with one of the public operating system images, specify
8597 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
8598 #
8599 # projects/debian-cloud/global/images/family/debian-9
8600 #
8601 #
8602 # Alternatively, use a specific version of a public operating system image:
8603 #
8604 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
8605 #
8606 #
8607 # To create a disk with a custom image that you created, specify the
8608 # image name in the following format:
8609 #
8610 # global/images/my-custom-image
8611 #
8612 #
8613 # You can also specify a custom image by its image family, which returns
8614 # the latest version of the image in that family. Replace the image name
8615 # with family/family-name:
8616 #
8617 # global/images/family/my-image-family
8618 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
8619 # encryption key of the source image. Required if the source image is
8620 # protected by a customer-supplied encryption key.
8621 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8622 # For example:
8623 #
8624 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8625 # key_region/cryptoKeys/key
8626 #
8627 # The fully-qualifed key name may be returned for resource GET requests. For
8628 # example:
8629 #
8630 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8631 # key_region/cryptoKeys/key
8632 # /cryptoKeyVersions/1
8633 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8634 # key. If absent, the Compute Engine default service account is used.
8635 # For example:
8636 #
8637 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8638 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8639 # encryption key, encoded in RFC
8640 # 4648 base64 to either encrypt or decrypt this resource. You can
8641 # provide either the rawKey or thersaEncryptedKey.
8642 # For example:
8643 #
8644 # &quot;rawKey&quot;:
8645 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8646 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8647 # customer-supplied encryption key to either encrypt or decrypt this
8648 # resource. You can provide either the rawKey or thersaEncryptedKey.
8649 # For example:
8650 #
8651 # &quot;rsaEncryptedKey&quot;:
8652 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8653 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8654 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8655 #
8656 # The key must meet the following requirements before you can provide it to
8657 # Compute Engine:
8658 #
8659 # 1. The key is wrapped using a RSA public key certificate provided by
8660 # Google.
8661 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8662 # encoding.
8663 #
8664 # Gets the RSA public key certificate provided by Google at:
8665 #
8666 #
8667 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8668 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8669 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8670 # encryption key that protects this resource.
8671 },
8672 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
8673 # value identifies the exact image that was used to create this persistent
8674 # disk. For example, if you created the persistent disk from an image that
8675 # was later deleted and recreated under the same name, the source image ID
8676 # would identify the exact version of the image that was used.
8677 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
8678 # this as a partial or full URL to the resource. For example, the following
8679 # are valid values:
8680 #
8681 #
8682 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
8683 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
8684 # - zones/zone/instantSnapshots/instantSnapshot
8685 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
8686 # disk. This value identifies the exact instant snapshot that was used to
8687 # create this persistent disk. For example, if you created the persistent
8688 # disk from an instant snapshot that was later deleted and recreated under
8689 # the same name, the source instant snapshot ID would identify the exact
8690 # version of the instant snapshot that was used.
8691 &quot;sourceMachineImage&quot;: &quot;A String&quot;, # The machine image to create the disk from. You can provide this as a
8692 # partial or full URL to the resource. For example, the following are valid
8693 # values:
8694 #
8695 #
8696 # - https://www.googleapis.com/compute/v1/projects/project/global/machineImages/machineImage
8697 # - projects/project/global/machineImages/machineImage
8698 # - global/machineImages/machineImage
8699 &quot;sourceMachineImageDiskDeviceName&quot;: &quot;A String&quot;, # The device name of a disk within a given machine image. The
8700 # source_machine_image must be specified.
8701 &quot;sourceMachineImageEncryptionKey&quot;: { # Thecustomer-supplied
8702 # encryption key of the source machine image. Required if the source
8703 # machine image is protected by a customer-supplied encryption key.
8704 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8705 # For example:
8706 #
8707 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8708 # key_region/cryptoKeys/key
8709 #
8710 # The fully-qualifed key name may be returned for resource GET requests. For
8711 # example:
8712 #
8713 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8714 # key_region/cryptoKeys/key
8715 # /cryptoKeyVersions/1
8716 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8717 # key. If absent, the Compute Engine default service account is used.
8718 # For example:
8719 #
8720 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8721 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8722 # encryption key, encoded in RFC
8723 # 4648 base64 to either encrypt or decrypt this resource. You can
8724 # provide either the rawKey or thersaEncryptedKey.
8725 # For example:
8726 #
8727 # &quot;rawKey&quot;:
8728 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8729 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8730 # customer-supplied encryption key to either encrypt or decrypt this
8731 # resource. You can provide either the rawKey or thersaEncryptedKey.
8732 # For example:
8733 #
8734 # &quot;rsaEncryptedKey&quot;:
8735 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8736 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8737 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8738 #
8739 # The key must meet the following requirements before you can provide it to
8740 # Compute Engine:
8741 #
8742 # 1. The key is wrapped using a RSA public key certificate provided by
8743 # Google.
8744 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8745 # encoding.
8746 #
8747 # Gets the RSA public key certificate provided by Google at:
8748 #
8749 #
8750 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8751 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8752 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8753 # encryption key that protects this resource.
8754 },
8755 &quot;sourceMachineImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the machine image used to create this disk.
8756 # This value identifies the exact machine image that was used to create this
8757 # persistent disk. For example, if you created the persistent disk from a
8758 # machine image that was later deleted and recreated under the same name, the
8759 # source machine image ID would identify the exact version of the machine
8760 # image that was used.
8761 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
8762 # partial or full URL to the resource. For example, the following are valid
8763 # values:
8764 #
8765 #
8766 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
8767 # - projects/project/global/snapshots/snapshot
8768 # - global/snapshots/snapshot
8769 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
8770 # encryption key of the source snapshot. Required if the source snapshot
8771 # is protected by a customer-supplied encryption key.
8772 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8773 # For example:
8774 #
8775 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8776 # key_region/cryptoKeys/key
8777 #
8778 # The fully-qualifed key name may be returned for resource GET requests. For
8779 # example:
8780 #
8781 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8782 # key_region/cryptoKeys/key
8783 # /cryptoKeyVersions/1
8784 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8785 # key. If absent, the Compute Engine default service account is used.
8786 # For example:
8787 #
8788 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8789 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8790 # encryption key, encoded in RFC
8791 # 4648 base64 to either encrypt or decrypt this resource. You can
8792 # provide either the rawKey or thersaEncryptedKey.
8793 # For example:
8794 #
8795 # &quot;rawKey&quot;:
8796 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8797 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8798 # customer-supplied encryption key to either encrypt or decrypt this
8799 # resource. You can provide either the rawKey or thersaEncryptedKey.
8800 # For example:
8801 #
8802 # &quot;rsaEncryptedKey&quot;:
8803 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8804 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8805 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8806 #
8807 # The key must meet the following requirements before you can provide it to
8808 # Compute Engine:
8809 #
8810 # 1. The key is wrapped using a RSA public key certificate provided by
8811 # Google.
8812 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8813 # encoding.
8814 #
8815 # Gets the RSA public key certificate provided by Google at:
8816 #
8817 #
8818 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8819 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8820 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8821 # encryption key that protects this resource.
8822 },
8823 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
8824 # value identifies the exact snapshot that was used to create this persistent
8825 # disk. For example, if you created the persistent disk from a snapshot that
8826 # was later deleted and recreated under the same name, the source snapshot ID
8827 # would identify the exact version of the snapshot that was used.
8828 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
8829 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
8830 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
8831 # https://storage.googleapis.com/. This flag is not optimized for creating
8832 # multiple disks from a source storage object. To create many disks from a
8833 # source storage object, use gcloud compute images
8834 # import instead.
8835 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
8836 #
8837 #
8838 # - CREATING: Disk is provisioning.
8839 # - RESTORING: Source data is being copied into the
8840 # disk.
8841 # - FAILED: Disk creation failed.
8842 # - READY: Disk is ready for use.
8843 # - DELETING: Disk is deleting.
8844 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
8845 # this as a partial or full URL to the resource. For example, the following
8846 # are valid values:
8847 #
8848 #
8849 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
8850 # - projects/project/zones/zone/storagePools/storagePool
8851 # - zones/zone/storagePools/storagePool
8852 &quot;storageType&quot;: &quot;A String&quot;, # [Deprecated] Storage type of the persistent disk.
8853 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
8854 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
8855 # types.
8856 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
8857 # in form:projects/project/zones/zone/instances/instance
8858 &quot;A String&quot;,
8859 ],
8860 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
8861 # You must specify this field as part of the HTTP request URL. It is
8862 # not settable as a field in the request body.
8863 }
8864
8865 paths: string, A parameter (repeated)
8866 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8867 that if you must retry your request, the server will know to ignore the
8868 request if it has already been completed.
8869
8870 For example, consider a situation where you make an initial request and
8871 the request times out. If you make the request again with the same
8872 request ID, the server can check if original operation with the same
8873 request ID was received, and if so, will ignore the second request. This
8874 prevents clients from accidentally creating duplicate commitments.
8875
8876 The request ID must be
8877 a valid UUID with the exception that zero UUID is not supported
8878 (00000000-0000-0000-0000-000000000000).
8879 updateMask: string, update_mask indicates fields to be updated as part of this request.
8880 x__xgafv: string, V1 error format.
8881 Allowed values
8882 1 - v1 error format
8883 2 - v2 error format
8884
8885 Returns:
8886 An object of the form:
8887
8888 { # Represents an Operation resource.
8889 #
8890 # Google Compute Engine has three Operation resources:
8891 #
8892 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
8893 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
8894 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
8895 #
8896 # You can use an operation resource to manage asynchronous API requests.
8897 # For more information, readHandling
8898 # API responses.
8899 #
8900 # Operations can be global, regional or zonal.
8901 #
8902 # - For global operations, use the `globalOperations`
8903 # resource.
8904 # - For regional operations, use the
8905 # `regionOperations` resource.
8906 # - For zonal operations, use
8907 # the `zoneOperations` resource.
8908 #
8909 #
8910 #
8911 # For more information, read
8912 # Global, Regional, and Zonal Resources.
8913 #
8914 # Note that completed Operation resources have a limited
8915 # retention period.
8916 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8917 # Not present otherwise.
8918 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8919 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8920 # set when the operation is created.
8921 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8922 # text format.
8923 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8924 # this field will be populated.
8925 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8926 # operation.
8927 {
8928 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8929 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8930 # details. There is a set of defined message types to use for providing
8931 # details.The syntax depends on the error code. For example,
8932 # QuotaExceededInfo will have details when the error code is
8933 # QUOTA_EXCEEDED.
8934 {
8935 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8936 #
8937 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8938 # is not enabled:
8939 #
8940 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8941 # &quot;domain&quot;: &quot;googleapis.com&quot;
8942 # &quot;metadata&quot;: {
8943 # &quot;resource&quot;: &quot;projects/123&quot;,
8944 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8945 # }
8946 # }
8947 #
8948 # This response indicates that the pubsub.googleapis.com API is not enabled.
8949 #
8950 # Example of an error that is returned when attempting to create a Spanner
8951 # instance in a region that is out of stock:
8952 #
8953 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8954 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8955 # &quot;metadata&quot;: {
8956 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8957 # }
8958 # }
8959 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8960 # is typically the registered service name of the tool or product that
8961 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8962 # generated by some common infrastructure, the error domain must be a
8963 # globally unique value that identifies the infrastructure. For Google API
8964 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8965 &quot;metadatas&quot;: { # Additional structured details about this error.
8966 #
8967 # Keys must match a regular expression of `a-z+` but should
8968 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8969 # length. When identifying the current value of an exceeded limit, the units
8970 # should be contained in the key, not the value. For example, rather than
8971 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8972 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8973 # instances that can be created in a single (batch) request.
8974 &quot;a_key&quot;: &quot;A String&quot;,
8975 },
8976 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8977 # proximate cause of the error. Error reasons are unique within a particular
8978 # domain of errors. This should be at most 63 characters and match a
8979 # regular expression of `A-Z+[A-Z0-9]`, which represents
8980 # UPPER_SNAKE_CASE.
8981 },
8982 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8983 #
8984 # For example, if a quota check failed with an error indicating the calling
8985 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8986 # directly to the right place in the developer console to flip the bit.
8987 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8988 { # Describes a URL link.
8989 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8990 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8991 },
8992 ],
8993 },
8994 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8995 # which can be attached to an RPC error.
8996 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8997 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8998 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8999 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9000 },
9001 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9002 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9003 &quot;a_key&quot;: &quot;A String&quot;,
9004 },
9005 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9006 # type or metric.
9007 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9008 # or metric.
9009 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9010 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9011 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9012 },
9013 },
9014 ],
9015 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9016 # This property is optional.
9017 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9018 },
9019 ],
9020 },
9021 &quot;getVersionOperationMetadata&quot;: {
9022 &quot;inlineSbomInfo&quot;: {
9023 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9024 # appropriate identifiers.
9025 &quot;a_key&quot;: &quot;A String&quot;,
9026 },
9027 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9028 # identifiers.
9029 &quot;a_key&quot;: &quot;A String&quot;,
9030 },
9031 },
9032 },
9033 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9034 # message that was returned, such as `NOT FOUND`.
9035 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9036 # status code that was returned. For example, a `404` means the
9037 # resource was not found.
9038 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9039 # defined by the server.
9040 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9041 # This value is inRFC3339
9042 # text format.
9043 &quot;instancesBulkInsertOperationMetadata&quot;: {
9044 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9045 # Example key: zones/us-central1-a
9046 &quot;a_key&quot;: {
9047 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9048 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9049 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9050 # error.
9051 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9052 # if the flow is rolling forward or rolling back.
9053 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9054 },
9055 },
9056 },
9057 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9058 # Operation resources.
9059 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9060 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9061 # group of operations results from a `bulkInsert` API request.
9062 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9063 # `update`, or `delete`, and so on.
9064 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9065 # There is no requirement that this be linear or support any granularity of
9066 # operations. This should not be used to guess when the operation will be
9067 # complete. This number should monotonically increase as the operation
9068 # progresses.
9069 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9070 # applicable when performing regional operations.
9071 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9072 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9073 # this field will contain information on all underlying zonal actions and
9074 # their state.
9075 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9076 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9077 # Example key: zones/us-central1-a
9078 &quot;a_key&quot;: {
9079 &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
9080 # populated.
9081 # different programming environments, including REST APIs and RPC APIs. It is
9082 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9083 # three pieces of data: error code, error message, and error details.
9084 #
9085 # You can find out more about this error model and how to work with it in the
9086 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9087 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9088 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9089 # message types for APIs to use.
9090 {
9091 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9092 },
9093 ],
9094 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9095 # user-facing error message should be localized and sent in the
9096 # google.rpc.Status.details field, or localized by the client.
9097 },
9098 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9099 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9100 },
9101 },
9102 },
9103 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9104 # This value is inRFC3339
9105 # text format.
9106 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9107 # following:
9108 # `PENDING`, `RUNNING`, or `DONE`.
9109 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9110 # operation.
9111 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9112 # of the target resource.
9113 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9114 # operations related to creating a snapshot, this points to the disk
9115 # that the snapshot was created from.
9116 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9117 # `[email protected]` or
9118 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9119 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9120 # operation, this field will be populated.
9121 {
9122 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9123 # Engine returns NO_RESULTS_ON_PAGE if there
9124 # are no results in the response.
9125 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9126 # value format. For example:
9127 #
9128 # &quot;data&quot;: [
9129 # {
9130 # &quot;key&quot;: &quot;scope&quot;,
9131 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9132 # }
9133 {
9134 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9135 # returned. For example, for warnings where there are no results in a list
9136 # request for a particular zone, this key might be scope and
9137 # the key value might be the zone name. Other examples might be a key
9138 # indicating a deprecated resource and a suggested replacement, or a
9139 # warning about invalid network settings (for example, if an instance
9140 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9141 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9142 },
9143 ],
9144 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9145 },
9146 ],
9147 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9148 # applicable when performing per-zone operations.
9149 }</pre>
9150 </div>
9151
9152 <div class="method">
9153 <code class="details" id="updateKmsKey">updateKmsKey(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
9154 <pre>Rotates the customer-managed
9155 encryption key to the latest version for the specified persistent disk.
9156
9157 Args:
9158 project: string, Project ID for this request. (required)
9159 zone: string, The name of the zone for this request. (required)
9160 disk: string, Name of the Disk resource, should conform to RFC1035. (required)
9161 body: object, The request body.
9162 The object takes the form of:
9163
9164 {
9165 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The new KMS key to replace the current one on the disk. If empty, the disk
9166 # will be re-encrypted using the primary version of the disk&#x27;s current KMS
9167 # key.
9168 #
9169 # The KMS key can be provided in the following formats:
9170 #
9171 #
9172 # - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key
9173 #
9174 #
9175 # Where project is the project ID or
9176 # project number.
9177 }
9178
9179 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
9180 that if you must retry your request, the server will know to ignore the
9181 request if it has already been completed.
9182
9183 For example, consider a situation where you make an initial request and
9184 the request times out. If you make the request again with the same
9185 request ID, the server can check if original operation with the same
9186 request ID was received, and if so, will ignore the second request. This
9187 prevents clients from accidentally creating duplicate commitments.
9188
9189 The request ID must be
9190 a valid UUID with the exception that zero UUID is not supported
9191 (00000000-0000-0000-0000-000000000000).
9192 x__xgafv: string, V1 error format.
9193 Allowed values
9194 1 - v1 error format
9195 2 - v2 error format
9196
9197 Returns:
9198 An object of the form:
9199
9200 { # Represents an Operation resource.
9201 #
9202 # Google Compute Engine has three Operation resources:
9203 #
9204 # * [Global](/compute/docs/reference/rest/beta/globalOperations)
9205 # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
9206 # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
9207 #
9208 # You can use an operation resource to manage asynchronous API requests.
9209 # For more information, readHandling
9210 # API responses.
9211 #
9212 # Operations can be global, regional or zonal.
9213 #
9214 # - For global operations, use the `globalOperations`
9215 # resource.
9216 # - For regional operations, use the
9217 # `regionOperations` resource.
9218 # - For zonal operations, use
9219 # the `zoneOperations` resource.
9220 #
9221 #
9222 #
9223 # For more information, read
9224 # Global, Regional, and Zonal Resources.
9225 #
9226 # Note that completed Operation resources have a limited
9227 # retention period.
9228 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
9229 # Not present otherwise.
9230 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
9231 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
9232 # set when the operation is created.
9233 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
9234 # text format.
9235 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
9236 # this field will be populated.
9237 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
9238 # operation.
9239 {
9240 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
9241 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
9242 # details. There is a set of defined message types to use for providing
9243 # details.The syntax depends on the error code. For example,
9244 # QuotaExceededInfo will have details when the error code is
9245 # QUOTA_EXCEEDED.
9246 {
9247 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
9248 #
9249 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
9250 # is not enabled:
9251 #
9252 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
9253 # &quot;domain&quot;: &quot;googleapis.com&quot;
9254 # &quot;metadata&quot;: {
9255 # &quot;resource&quot;: &quot;projects/123&quot;,
9256 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
9257 # }
9258 # }
9259 #
9260 # This response indicates that the pubsub.googleapis.com API is not enabled.
9261 #
9262 # Example of an error that is returned when attempting to create a Spanner
9263 # instance in a region that is out of stock:
9264 #
9265 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
9266 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
9267 # &quot;metadata&quot;: {
9268 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
9269 # }
9270 # }
9271 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
9272 # is typically the registered service name of the tool or product that
9273 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
9274 # generated by some common infrastructure, the error domain must be a
9275 # globally unique value that identifies the infrastructure. For Google API
9276 # infrastructure, the error domain is &quot;googleapis.com&quot;.
9277 &quot;metadatas&quot;: { # Additional structured details about this error.
9278 #
9279 # Keys must match a regular expression of `a-z+` but should
9280 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
9281 # length. When identifying the current value of an exceeded limit, the units
9282 # should be contained in the key, not the value. For example, rather than
9283 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
9284 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
9285 # instances that can be created in a single (batch) request.
9286 &quot;a_key&quot;: &quot;A String&quot;,
9287 },
9288 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
9289 # proximate cause of the error. Error reasons are unique within a particular
9290 # domain of errors. This should be at most 63 characters and match a
9291 # regular expression of `A-Z+[A-Z0-9]`, which represents
9292 # UPPER_SNAKE_CASE.
9293 },
9294 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
9295 #
9296 # For example, if a quota check failed with an error indicating the calling
9297 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
9298 # directly to the right place in the developer console to flip the bit.
9299 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
9300 { # Describes a URL link.
9301 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
9302 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
9303 },
9304 ],
9305 },
9306 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
9307 # which can be attached to an RPC error.
9308 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
9309 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
9310 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
9311 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
9312 },
9313 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
9314 &quot;dimensions&quot;: { # The map holding related quota dimensions.
9315 &quot;a_key&quot;: &quot;A String&quot;,
9316 },
9317 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
9318 # type or metric.
9319 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
9320 # or metric.
9321 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
9322 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
9323 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
9324 },
9325 },
9326 ],
9327 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
9328 # This property is optional.
9329 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
9330 },
9331 ],
9332 },
9333 &quot;getVersionOperationMetadata&quot;: {
9334 &quot;inlineSbomInfo&quot;: {
9335 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
9336 # appropriate identifiers.
9337 &quot;a_key&quot;: &quot;A String&quot;,
9338 },
9339 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
9340 # identifiers.
9341 &quot;a_key&quot;: &quot;A String&quot;,
9342 },
9343 },
9344 },
9345 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
9346 # message that was returned, such as `NOT FOUND`.
9347 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
9348 # status code that was returned. For example, a `404` means the
9349 # resource was not found.
9350 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
9351 # defined by the server.
9352 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
9353 # This value is inRFC3339
9354 # text format.
9355 &quot;instancesBulkInsertOperationMetadata&quot;: {
9356 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
9357 # Example key: zones/us-central1-a
9358 &quot;a_key&quot;: {
9359 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
9360 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
9361 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
9362 # error.
9363 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
9364 # if the flow is rolling forward or rolling back.
9365 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
9366 },
9367 },
9368 },
9369 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
9370 # Operation resources.
9371 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
9372 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
9373 # group of operations results from a `bulkInsert` API request.
9374 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
9375 # `update`, or `delete`, and so on.
9376 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
9377 # There is no requirement that this be linear or support any granularity of
9378 # operations. This should not be used to guess when the operation will be
9379 # complete. This number should monotonically increase as the operation
9380 # progresses.
9381 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
9382 # applicable when performing regional operations.
9383 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
9384 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
9385 # this field will contain information on all underlying zonal actions and
9386 # their state.
9387 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
9388 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
9389 # Example key: zones/us-central1-a
9390 &quot;a_key&quot;: {
9391 &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
9392 # populated.
9393 # different programming environments, including REST APIs and RPC APIs. It is
9394 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
9395 # three pieces of data: error code, error message, and error details.
9396 #
9397 # You can find out more about this error model and how to work with it in the
9398 # [API Design Guide](https://cloud.google.com/apis/design/errors).
9399 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
9400 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
9401 # message types for APIs to use.
9402 {
9403 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
9404 },
9405 ],
9406 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
9407 # user-facing error message should be localized and sent in the
9408 # google.rpc.Status.details field, or localized by the client.
9409 },
9410 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
9411 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
9412 },
9413 },
9414 },
9415 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
9416 # This value is inRFC3339
9417 # text format.
9418 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
9419 # following:
9420 # `PENDING`, `RUNNING`, or `DONE`.
9421 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
9422 # operation.
9423 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
9424 # of the target resource.
9425 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
9426 # operations related to creating a snapshot, this points to the disk
9427 # that the snapshot was created from.
9428 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
9429 # `[email protected]` or
9430 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
9431 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
9432 # operation, this field will be populated.
9433 {
9434 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
9435 # Engine returns NO_RESULTS_ON_PAGE if there
9436 # are no results in the response.
9437 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
9438 # value format. For example:
9439 #
9440 # &quot;data&quot;: [
9441 # {
9442 # &quot;key&quot;: &quot;scope&quot;,
9443 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
9444 # }
9445 {
9446 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
9447 # returned. For example, for warnings where there are no results in a list
9448 # request for a particular zone, this key might be scope and
9449 # the key value might be the zone name. Other examples might be a key
9450 # indicating a deprecated resource and a suggested replacement, or a
9451 # warning about invalid network settings (for example, if an instance
9452 # attempts to perform IP forwarding but is not enabled for IP forwarding).
9453 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
9454 },
9455 ],
9456 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
9457 },
9458 ],
9459 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
9460 # applicable when performing per-zone operations.
9461 }</pre>
9462 </div>
9463
9464 </body></html>