Debian Codegraph @

docs/dyn/compute_v1.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_v1.html">Compute Engine API</a> . <a href="compute_v1.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/v1/globalOperations)
193 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
194 # * [Zonal](/compute/docs/reference/rest/v1/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/v1/disks)
571 # * [Regional](/compute/docs/reference/rest/v1/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;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
723 # only for bootable images. Read
724 # Enabling guest operating system features to see a list of available
725 # options.
726 { # Guest OS features.
727 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
728 # separate values. Set to one or more of the following values:
729 #
730 # - VIRTIO_SCSI_MULTIQUEUE
731 # - WINDOWS
732 # - MULTI_IP_SUBNET
733 # - UEFI_COMPATIBLE
734 # - GVNIC
735 # - SEV_CAPABLE
736 # - SUSPEND_RESUME_COMPATIBLE
737 # - SEV_LIVE_MIGRATABLE_V2
738 # - SEV_SNP_CAPABLE
739 # - TDX_CAPABLE
740 # - IDPF
741 # - SNP_SVSM_CAPABLE
742 # - CCA_CAPABLE
743 #
744 #
745 # For more information, see
746 # Enabling guest operating system features.
747 },
748 ],
749 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
750 # defined by the server.
751 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
752 # disks.
753 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
754 # essentially a hash of the labels set used for optimistic locking. The
755 # fingerprint is initially generated by Compute Engine and changes after
756 # every request to modify or update labels. You must always provide an
757 # up-to-date fingerprint hash in order to update or change labels,
758 # otherwise the request will fail with error412 conditionNotMet.
759 #
760 # To see the latest fingerprint, make a get() request to
761 # retrieve a disk.
762 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
763 # the setLabels method.
764 &quot;a_key&quot;: &quot;A String&quot;,
765 },
766 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
767 # text format.
768 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
769 # text format.
770 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
771 &quot;A String&quot;,
772 ],
773 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
774 &quot;A String&quot;,
775 ],
776 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
777 # This field is for use by internal tools that use the public API.
778 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
779 # The name must be 1-63 characters long, and comply withRFC1035.
780 # Specifically, the name must be 1-63 characters long and match the regular
781 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
782 # which means the first character must be a lowercase letter, and all
783 # following characters must be a dash, lowercase letter, or digit, except
784 # the last character, which cannot be a dash.
785 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
786 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
787 # as part of resource payload.
788 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
789 # have the same definition as resource
790 # manager tags. Keys and values can be either in numeric format,
791 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
792 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
793 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
794 # PATCH) when empty.
795 &quot;a_key&quot;: &quot;A String&quot;,
796 },
797 },
798 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
799 # If not present in a request, a default value is used.
800 # The currently supported size is 4096, other sizes may be added in
801 # the future.
802 # If an unsupported value is requested, the error message will list
803 # the supported values for the caller&#x27;s project.
804 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
805 # of I/O operations per second that the disk can handle. Values must be
806 # between 10,000 and 120,000. For more details, see theExtreme persistent
807 # disk documentation.
808 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
809 # number of throughput mb per second that the disk can handle. Values must be
810 # greater than or equal to 1.
811 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
812 # regional resources.
813 # You must specify this field as part of the HTTP request URL. It is
814 # not settable as a field in the request body.
815 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
816 # for regional resources.
817 &quot;A String&quot;,
818 ],
819 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
820 &quot;A String&quot;,
821 ],
822 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
823 &quot;asyncPrimaryDisk&quot;: {
824 &quot;state&quot;: &quot;A String&quot;,
825 },
826 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
827 &quot;a_key&quot;: {
828 &quot;state&quot;: &quot;A String&quot;,
829 },
830 },
831 },
832 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
833 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
834 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
835 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
836 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
837 # persistent disk.
838 #
839 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
840 # source.
841 # Acceptable values are greater than 0.
842 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
843 # that was created using a consistency group.
844 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
845 # that was created using a consistency group.
846 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
847 # partial or full URL to the resource. For example, the following are valid
848 # values:
849 #
850 #
851 # -
852 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
853 #
854 # -
855 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
856 #
857 # -
858 # projects/project/zones/zone/disks/disk
859 #
860 # -
861 # projects/project/regions/region/disks/disk
862 #
863 # -
864 # zones/zone/disks/disk
865 #
866 # -
867 # regions/region/disks/disk
868 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
869 # value identifies the exact disk that was used to create this persistent
870 # disk. For example, if you created the persistent disk from a disk that
871 # was later deleted and recreated under the same name, the source disk ID
872 # would identify the exact version of the disk that was used.
873 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
874 # deleted, this field will not be set.
875 #
876 # To create a disk with one of the public operating system images, specify
877 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
878 #
879 # projects/debian-cloud/global/images/family/debian-9
880 #
881 #
882 # Alternatively, use a specific version of a public operating system image:
883 #
884 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
885 #
886 #
887 # To create a disk with a custom image that you created, specify the
888 # image name in the following format:
889 #
890 # global/images/my-custom-image
891 #
892 #
893 # You can also specify a custom image by its image family, which returns
894 # the latest version of the image in that family. Replace the image name
895 # with family/family-name:
896 #
897 # global/images/family/my-image-family
898 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
899 # encryption key of the source image. Required if the source image is
900 # protected by a customer-supplied encryption key.
901 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
902 # For example:
903 #
904 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
905 # key_region/cryptoKeys/key
906 #
907 # The fully-qualifed key name may be returned for resource GET requests. For
908 # example:
909 #
910 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
911 # key_region/cryptoKeys/key
912 # /cryptoKeyVersions/1
913 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
914 # key. If absent, the Compute Engine default service account is used.
915 # For example:
916 #
917 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
918 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
919 # encryption key, encoded in RFC
920 # 4648 base64 to either encrypt or decrypt this resource. You can
921 # provide either the rawKey or thersaEncryptedKey.
922 # For example:
923 #
924 # &quot;rawKey&quot;:
925 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
926 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
927 # customer-supplied encryption key to either encrypt or decrypt this
928 # resource. You can provide either the rawKey or thersaEncryptedKey.
929 # For example:
930 #
931 # &quot;rsaEncryptedKey&quot;:
932 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
933 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
934 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
935 #
936 # The key must meet the following requirements before you can provide it to
937 # Compute Engine:
938 #
939 # 1. The key is wrapped using a RSA public key certificate provided by
940 # Google.
941 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
942 # encoding.
943 #
944 # Gets the RSA public key certificate provided by Google at:
945 #
946 #
947 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
948 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
949 # 4648 base64 encoded SHA-256 hash of the customer-supplied
950 # encryption key that protects this resource.
951 },
952 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
953 # value identifies the exact image that was used to create this persistent
954 # disk. For example, if you created the persistent disk from an image that
955 # was later deleted and recreated under the same name, the source image ID
956 # would identify the exact version of the image that was used.
957 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
958 # this as a partial or full URL to the resource. For example, the following
959 # are valid values:
960 #
961 #
962 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
963 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
964 # - zones/zone/instantSnapshots/instantSnapshot
965 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
966 # disk. This value identifies the exact instant snapshot that was used to
967 # create this persistent disk. For example, if you created the persistent
968 # disk from an instant snapshot that was later deleted and recreated under
969 # the same name, the source instant snapshot ID would identify the exact
970 # version of the instant snapshot that was used.
971 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
972 # partial or full URL to the resource. For example, the following are valid
973 # values:
974 #
975 #
976 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
977 # - projects/project/global/snapshots/snapshot
978 # - global/snapshots/snapshot
979 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
980 # encryption key of the source snapshot. Required if the source snapshot
981 # is protected by a customer-supplied encryption key.
982 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
983 # For example:
984 #
985 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
986 # key_region/cryptoKeys/key
987 #
988 # The fully-qualifed key name may be returned for resource GET requests. For
989 # example:
990 #
991 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
992 # key_region/cryptoKeys/key
993 # /cryptoKeyVersions/1
994 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
995 # key. If absent, the Compute Engine default service account is used.
996 # For example:
997 #
998 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
999 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1000 # encryption key, encoded in RFC
1001 # 4648 base64 to either encrypt or decrypt this resource. You can
1002 # provide either the rawKey or thersaEncryptedKey.
1003 # For example:
1004 #
1005 # &quot;rawKey&quot;:
1006 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1007 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1008 # customer-supplied encryption key to either encrypt or decrypt this
1009 # resource. You can provide either the rawKey or thersaEncryptedKey.
1010 # For example:
1011 #
1012 # &quot;rsaEncryptedKey&quot;:
1013 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1014 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1015 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1016 #
1017 # The key must meet the following requirements before you can provide it to
1018 # Compute Engine:
1019 #
1020 # 1. The key is wrapped using a RSA public key certificate provided by
1021 # Google.
1022 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1023 # encoding.
1024 #
1025 # Gets the RSA public key certificate provided by Google at:
1026 #
1027 #
1028 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1029 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1030 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1031 # encryption key that protects this resource.
1032 },
1033 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
1034 # value identifies the exact snapshot that was used to create this persistent
1035 # disk. For example, if you created the persistent disk from a snapshot that
1036 # was later deleted and recreated under the same name, the source snapshot ID
1037 # would identify the exact version of the snapshot that was used.
1038 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
1039 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
1040 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
1041 # https://storage.googleapis.com/. This flag is not optimized for creating
1042 # multiple disks from a source storage object. To create many disks from a
1043 # source storage object, use gcloud compute images
1044 # import instead.
1045 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
1046 #
1047 #
1048 # - CREATING: Disk is provisioning.
1049 # - RESTORING: Source data is being copied into the
1050 # disk.
1051 # - FAILED: Disk creation failed.
1052 # - READY: Disk is ready for use.
1053 # - DELETING: Disk is deleting.
1054 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
1055 # this as a partial or full URL to the resource. For example, the following
1056 # are valid values:
1057 #
1058 #
1059 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
1060 # - projects/project/zones/zone/storagePools/storagePool
1061 # - zones/zone/storagePools/storagePool
1062 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
1063 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
1064 # types.
1065 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
1066 # in form:projects/project/zones/zone/instances/instance
1067 &quot;A String&quot;,
1068 ],
1069 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
1070 # You must specify this field as part of the HTTP request URL. It is
1071 # not settable as a field in the request body.
1072 },
1073 ],
1074 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of disks when
1075 # the list is empty.
1076 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1077 # Engine returns NO_RESULTS_ON_PAGE if there
1078 # are no results in the response.
1079 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1080 # value format. For example:
1081 #
1082 # &quot;data&quot;: [
1083 # {
1084 # &quot;key&quot;: &quot;scope&quot;,
1085 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1086 # }
1087 {
1088 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1089 # returned. For example, for warnings where there are no results in a list
1090 # request for a particular zone, this key might be scope and
1091 # the key value might be the zone name. Other examples might be a key
1092 # indicating a deprecated resource and a suggested replacement, or a
1093 # warning about invalid network settings (for example, if an instance
1094 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1095 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1096 },
1097 ],
1098 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1099 },
1100 },
1101 },
1102 &quot;kind&quot;: &quot;compute#diskAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#diskAggregatedList for aggregated lists of persistent
1103 # disks.
1104 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
1105 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
1106 # the query parameter pageToken in the next list request.
1107 # Subsequent list requests will have their own nextPageToken to
1108 # continue paging through the results.
1109 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
1110 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
1111 &quot;A String&quot;,
1112 ],
1113 &quot;warning&quot;: { # [Output Only] Informational warning message.
1114 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1115 # Engine returns NO_RESULTS_ON_PAGE if there
1116 # are no results in the response.
1117 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1118 # value format. For example:
1119 #
1120 # &quot;data&quot;: [
1121 # {
1122 # &quot;key&quot;: &quot;scope&quot;,
1123 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1124 # }
1125 {
1126 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1127 # returned. For example, for warnings where there are no results in a list
1128 # request for a particular zone, this key might be scope and
1129 # the key value might be the zone name. Other examples might be a key
1130 # indicating a deprecated resource and a suggested replacement, or a
1131 # warning about invalid network settings (for example, if an instance
1132 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1133 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1134 },
1135 ],
1136 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1137 },
1138 }</pre>
1139 </div>
1140
1141 <div class="method">
1142 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
1143 <pre>Retrieves the next page of results.
1144
1145 Args:
1146 previous_request: The request for the previous page. (required)
1147 previous_response: The response from the request for the previous page. (required)
1148
1149 Returns:
1150 A request object that you can call &#x27;execute()&#x27; on to request the next
1151 page. Returns None if there are no more items in the collection.
1152 </pre>
1153 </div>
1154
1155 <div class="method">
1156 <code class="details" id="bulkInsert">bulkInsert(project, zone, body=None, requestId=None, x__xgafv=None)</code>
1157 <pre>Bulk create a set of disks.
1158
1159 Args:
1160 project: string, Project ID for this request. (required)
1161 zone: string, The name of the zone for this request. (required)
1162 body: object, The request body.
1163 The object takes the form of:
1164
1165 { # A transient resource used in compute.disks.bulkInsert and
1166 # compute.regionDisks.bulkInsert. It is only used to process
1167 # requests and is not persisted.
1168 &quot;instantSnapshotGroupParameters&quot;: { # The parameters for the instant snapshot group.
1169 &quot;sourceInstantSnapshotGroup&quot;: &quot;A String&quot;, # The source instant snapshot group used to create disks. You can provide
1170 # this as a partial or full URL to the resource. For example, the following
1171 # are valid values:
1172 #
1173 #
1174 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup
1175 # - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup
1176 # - zones/zone/instantSnapshotGroups/instantSnapshotGroup
1177 },
1178 &quot;snapshotGroupParameters&quot;: { # The parameters for the snapshot group. The usage of snapshot group feature
1179 # is restricted.
1180 &quot;replicaZones&quot;: [ # URLs of the zones where disks should be replicated to. Only applicable
1181 # for regional resources.
1182 &quot;A String&quot;,
1183 ],
1184 &quot;sourceSnapshotGroup&quot;: &quot;A String&quot;, # The source snapshot group used to create disks. You can provide this as a
1185 # partial or full URL to the resource. For example, the following are valid
1186 # values:
1187 #
1188 #
1189 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup
1190 # - projects/project/global/snapshotGroups/snapshotGroup
1191 # - global/snapshotGroups/snapshotGroup
1192 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
1193 # disks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
1194 # types.
1195 },
1196 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.
1197 # This may be a full or partial URL, such as:
1198 #
1199 #
1200 # -
1201 # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
1202 #
1203 # -
1204 # projects/project/regions/region/resourcePolicies/resourcePolicy
1205 #
1206 # -
1207 # regions/region/resourcePolicies/resourcePolicy
1208 }
1209
1210 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1211 that if you must retry your request, the server will know to ignore the
1212 request if it has already been completed.
1213
1214 For example, consider a situation where you make an initial request and
1215 the request times out. If you make the request again with the same
1216 request ID, the server can check if original operation with the same
1217 request ID was received, and if so, will ignore the second request. This
1218 prevents clients from accidentally creating duplicate commitments.
1219
1220 The request ID must be
1221 a valid UUID with the exception that zero UUID is not supported
1222 (00000000-0000-0000-0000-000000000000).
1223 x__xgafv: string, V1 error format.
1224 Allowed values
1225 1 - v1 error format
1226 2 - v2 error format
1227
1228 Returns:
1229 An object of the form:
1230
1231 { # Represents an Operation resource.
1232 #
1233 # Google Compute Engine has three Operation resources:
1234 #
1235 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1236 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1237 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1238 #
1239 # You can use an operation resource to manage asynchronous API requests.
1240 # For more information, readHandling
1241 # API responses.
1242 #
1243 # Operations can be global, regional or zonal.
1244 #
1245 # - For global operations, use the `globalOperations`
1246 # resource.
1247 # - For regional operations, use the
1248 # `regionOperations` resource.
1249 # - For zonal operations, use
1250 # the `zoneOperations` resource.
1251 #
1252 #
1253 #
1254 # For more information, read
1255 # Global, Regional, and Zonal Resources.
1256 #
1257 # Note that completed Operation resources have a limited
1258 # retention period.
1259 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1260 # Not present otherwise.
1261 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1262 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1263 # set when the operation is created.
1264 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1265 # text format.
1266 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1267 # this field will be populated.
1268 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1269 # operation.
1270 {
1271 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1272 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1273 # details. There is a set of defined message types to use for providing
1274 # details.The syntax depends on the error code. For example,
1275 # QuotaExceededInfo will have details when the error code is
1276 # QUOTA_EXCEEDED.
1277 {
1278 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1279 #
1280 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1281 # is not enabled:
1282 #
1283 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1284 # &quot;domain&quot;: &quot;googleapis.com&quot;
1285 # &quot;metadata&quot;: {
1286 # &quot;resource&quot;: &quot;projects/123&quot;,
1287 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1288 # }
1289 # }
1290 #
1291 # This response indicates that the pubsub.googleapis.com API is not enabled.
1292 #
1293 # Example of an error that is returned when attempting to create a Spanner
1294 # instance in a region that is out of stock:
1295 #
1296 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1297 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1298 # &quot;metadata&quot;: {
1299 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1300 # }
1301 # }
1302 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1303 # is typically the registered service name of the tool or product that
1304 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1305 # generated by some common infrastructure, the error domain must be a
1306 # globally unique value that identifies the infrastructure. For Google API
1307 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1308 &quot;metadatas&quot;: { # Additional structured details about this error.
1309 #
1310 # Keys must match a regular expression of `a-z+` but should
1311 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1312 # length. When identifying the current value of an exceeded limit, the units
1313 # should be contained in the key, not the value. For example, rather than
1314 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1315 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1316 # instances that can be created in a single (batch) request.
1317 &quot;a_key&quot;: &quot;A String&quot;,
1318 },
1319 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1320 # proximate cause of the error. Error reasons are unique within a particular
1321 # domain of errors. This should be at most 63 characters and match a
1322 # regular expression of `A-Z+[A-Z0-9]`, which represents
1323 # UPPER_SNAKE_CASE.
1324 },
1325 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1326 #
1327 # For example, if a quota check failed with an error indicating the calling
1328 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1329 # directly to the right place in the developer console to flip the bit.
1330 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1331 { # Describes a URL link.
1332 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1333 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1334 },
1335 ],
1336 },
1337 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1338 # which can be attached to an RPC error.
1339 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1340 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1341 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1342 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1343 },
1344 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1345 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1346 &quot;a_key&quot;: &quot;A String&quot;,
1347 },
1348 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1349 # type or metric.
1350 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1351 # or metric.
1352 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1353 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1354 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1355 },
1356 },
1357 ],
1358 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1359 # This property is optional.
1360 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1361 },
1362 ],
1363 },
1364 &quot;getVersionOperationMetadata&quot;: {
1365 &quot;inlineSbomInfo&quot;: {
1366 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1367 # appropriate identifiers.
1368 &quot;a_key&quot;: &quot;A String&quot;,
1369 },
1370 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1371 # identifiers.
1372 &quot;a_key&quot;: &quot;A String&quot;,
1373 },
1374 },
1375 },
1376 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1377 # message that was returned, such as `NOT FOUND`.
1378 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1379 # status code that was returned. For example, a `404` means the
1380 # resource was not found.
1381 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1382 # defined by the server.
1383 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1384 # This value is inRFC3339
1385 # text format.
1386 &quot;instancesBulkInsertOperationMetadata&quot;: {
1387 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1388 # Example key: zones/us-central1-a
1389 &quot;a_key&quot;: {
1390 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1391 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1392 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1393 # error.
1394 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1395 # if the flow is rolling forward or rolling back.
1396 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1397 },
1398 },
1399 },
1400 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1401 # Operation resources.
1402 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1403 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1404 # group of operations results from a `bulkInsert` API request.
1405 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1406 # `update`, or `delete`, and so on.
1407 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1408 # There is no requirement that this be linear or support any granularity of
1409 # operations. This should not be used to guess when the operation will be
1410 # complete. This number should monotonically increase as the operation
1411 # progresses.
1412 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1413 # applicable when performing regional operations.
1414 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1415 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1416 # this field will contain information on all underlying zonal actions and
1417 # their state.
1418 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1419 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1420 # Example key: zones/us-central1-a
1421 &quot;a_key&quot;: {
1422 &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
1423 # populated.
1424 # different programming environments, including REST APIs and RPC APIs. It is
1425 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1426 # three pieces of data: error code, error message, and error details.
1427 #
1428 # You can find out more about this error model and how to work with it in the
1429 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1430 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1431 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1432 # message types for APIs to use.
1433 {
1434 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1435 },
1436 ],
1437 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1438 # user-facing error message should be localized and sent in the
1439 # google.rpc.Status.details field, or localized by the client.
1440 },
1441 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1442 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1443 },
1444 },
1445 },
1446 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1447 # This value is inRFC3339
1448 # text format.
1449 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1450 # following:
1451 # `PENDING`, `RUNNING`, or `DONE`.
1452 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1453 # operation.
1454 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1455 # of the target resource.
1456 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1457 # operations related to creating a snapshot, this points to the disk
1458 # that the snapshot was created from.
1459 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1460 # `[email protected]` or
1461 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1462 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1463 # operation, this field will be populated.
1464 {
1465 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1466 # Engine returns NO_RESULTS_ON_PAGE if there
1467 # are no results in the response.
1468 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1469 # value format. For example:
1470 #
1471 # &quot;data&quot;: [
1472 # {
1473 # &quot;key&quot;: &quot;scope&quot;,
1474 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1475 # }
1476 {
1477 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1478 # returned. For example, for warnings where there are no results in a list
1479 # request for a particular zone, this key might be scope and
1480 # the key value might be the zone name. Other examples might be a key
1481 # indicating a deprecated resource and a suggested replacement, or a
1482 # warning about invalid network settings (for example, if an instance
1483 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1484 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1485 },
1486 ],
1487 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1488 },
1489 ],
1490 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1491 # applicable when performing per-zone operations.
1492 }</pre>
1493 </div>
1494
1495 <div class="method">
1496 <code class="details" id="bulkSetLabels">bulkSetLabels(project, zone, body=None, requestId=None, resource=None, x__xgafv=None)</code>
1497 <pre>Sets the labels on many disks at once. To learn more about labels, read theLabeling
1498 Resources documentation.
1499
1500 Args:
1501 project: string, Project ID for this request. (required)
1502 zone: string, The name of the zone for this request. (required)
1503 body: object, The request body.
1504 The object takes the form of:
1505
1506 {
1507 &quot;requests&quot;: [
1508 {
1509 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
1510 # used to detect conflicts. The fingerprint is initially generated by Compute
1511 # Engine and changes after every request to modify or update labels. You may
1512 # optionally provide an up-to-date fingerprint hash in order to update or
1513 # change labels. Make a get() request to the resource to get the
1514 # latest fingerprint.
1515 &quot;labels&quot;: { # The labels to set for this resource.
1516 &quot;a_key&quot;: &quot;A String&quot;,
1517 },
1518 },
1519 ],
1520 }
1521
1522 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
1523 that if you must retry your request, the server will know to ignore the
1524 request if it has already been completed.
1525
1526 For example, consider a situation where you make an initial request and
1527 the request times out. If you make the request again with the same
1528 request ID, the server can check if original operation with the same
1529 request ID was received, and if so, will ignore the second request. This
1530 prevents clients from accidentally creating duplicate commitments.
1531
1532 The request ID must be
1533 a valid UUID with the exception that zero UUID is not supported
1534 (00000000-0000-0000-0000-000000000000).
1535 resource: string, Name or id of the resource for this request.
1536 x__xgafv: string, V1 error format.
1537 Allowed values
1538 1 - v1 error format
1539 2 - v2 error format
1540
1541 Returns:
1542 An object of the form:
1543
1544 { # Represents an Operation resource.
1545 #
1546 # Google Compute Engine has three Operation resources:
1547 #
1548 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
1549 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
1550 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
1551 #
1552 # You can use an operation resource to manage asynchronous API requests.
1553 # For more information, readHandling
1554 # API responses.
1555 #
1556 # Operations can be global, regional or zonal.
1557 #
1558 # - For global operations, use the `globalOperations`
1559 # resource.
1560 # - For regional operations, use the
1561 # `regionOperations` resource.
1562 # - For zonal operations, use
1563 # the `zoneOperations` resource.
1564 #
1565 #
1566 #
1567 # For more information, read
1568 # Global, Regional, and Zonal Resources.
1569 #
1570 # Note that completed Operation resources have a limited
1571 # retention period.
1572 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
1573 # Not present otherwise.
1574 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
1575 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
1576 # set when the operation is created.
1577 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
1578 # text format.
1579 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
1580 # this field will be populated.
1581 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
1582 # operation.
1583 {
1584 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
1585 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
1586 # details. There is a set of defined message types to use for providing
1587 # details.The syntax depends on the error code. For example,
1588 # QuotaExceededInfo will have details when the error code is
1589 # QUOTA_EXCEEDED.
1590 {
1591 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
1592 #
1593 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
1594 # is not enabled:
1595 #
1596 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
1597 # &quot;domain&quot;: &quot;googleapis.com&quot;
1598 # &quot;metadata&quot;: {
1599 # &quot;resource&quot;: &quot;projects/123&quot;,
1600 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
1601 # }
1602 # }
1603 #
1604 # This response indicates that the pubsub.googleapis.com API is not enabled.
1605 #
1606 # Example of an error that is returned when attempting to create a Spanner
1607 # instance in a region that is out of stock:
1608 #
1609 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
1610 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
1611 # &quot;metadata&quot;: {
1612 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
1613 # }
1614 # }
1615 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
1616 # is typically the registered service name of the tool or product that
1617 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
1618 # generated by some common infrastructure, the error domain must be a
1619 # globally unique value that identifies the infrastructure. For Google API
1620 # infrastructure, the error domain is &quot;googleapis.com&quot;.
1621 &quot;metadatas&quot;: { # Additional structured details about this error.
1622 #
1623 # Keys must match a regular expression of `a-z+` but should
1624 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
1625 # length. When identifying the current value of an exceeded limit, the units
1626 # should be contained in the key, not the value. For example, rather than
1627 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
1628 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
1629 # instances that can be created in a single (batch) request.
1630 &quot;a_key&quot;: &quot;A String&quot;,
1631 },
1632 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
1633 # proximate cause of the error. Error reasons are unique within a particular
1634 # domain of errors. This should be at most 63 characters and match a
1635 # regular expression of `A-Z+[A-Z0-9]`, which represents
1636 # UPPER_SNAKE_CASE.
1637 },
1638 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
1639 #
1640 # For example, if a quota check failed with an error indicating the calling
1641 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
1642 # directly to the right place in the developer console to flip the bit.
1643 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
1644 { # Describes a URL link.
1645 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
1646 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
1647 },
1648 ],
1649 },
1650 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
1651 # which can be attached to an RPC error.
1652 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
1653 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
1654 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
1655 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
1656 },
1657 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
1658 &quot;dimensions&quot;: { # The map holding related quota dimensions.
1659 &quot;a_key&quot;: &quot;A String&quot;,
1660 },
1661 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
1662 # type or metric.
1663 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
1664 # or metric.
1665 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
1666 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
1667 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
1668 },
1669 },
1670 ],
1671 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
1672 # This property is optional.
1673 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
1674 },
1675 ],
1676 },
1677 &quot;getVersionOperationMetadata&quot;: {
1678 &quot;inlineSbomInfo&quot;: {
1679 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
1680 # appropriate identifiers.
1681 &quot;a_key&quot;: &quot;A String&quot;,
1682 },
1683 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
1684 # identifiers.
1685 &quot;a_key&quot;: &quot;A String&quot;,
1686 },
1687 },
1688 },
1689 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
1690 # message that was returned, such as `NOT FOUND`.
1691 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
1692 # status code that was returned. For example, a `404` means the
1693 # resource was not found.
1694 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
1695 # defined by the server.
1696 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
1697 # This value is inRFC3339
1698 # text format.
1699 &quot;instancesBulkInsertOperationMetadata&quot;: {
1700 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
1701 # Example key: zones/us-central1-a
1702 &quot;a_key&quot;: {
1703 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
1704 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
1705 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
1706 # error.
1707 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
1708 # if the flow is rolling forward or rolling back.
1709 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
1710 },
1711 },
1712 },
1713 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
1714 # Operation resources.
1715 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
1716 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
1717 # group of operations results from a `bulkInsert` API request.
1718 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
1719 # `update`, or `delete`, and so on.
1720 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
1721 # There is no requirement that this be linear or support any granularity of
1722 # operations. This should not be used to guess when the operation will be
1723 # complete. This number should monotonically increase as the operation
1724 # progresses.
1725 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
1726 # applicable when performing regional operations.
1727 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
1728 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
1729 # this field will contain information on all underlying zonal actions and
1730 # their state.
1731 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
1732 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
1733 # Example key: zones/us-central1-a
1734 &quot;a_key&quot;: {
1735 &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
1736 # populated.
1737 # different programming environments, including REST APIs and RPC APIs. It is
1738 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1739 # three pieces of data: error code, error message, and error details.
1740 #
1741 # You can find out more about this error model and how to work with it in the
1742 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1743 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1744 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1745 # message types for APIs to use.
1746 {
1747 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1748 },
1749 ],
1750 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1751 # user-facing error message should be localized and sent in the
1752 # google.rpc.Status.details field, or localized by the client.
1753 },
1754 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
1755 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
1756 },
1757 },
1758 },
1759 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
1760 # This value is inRFC3339
1761 # text format.
1762 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
1763 # following:
1764 # `PENDING`, `RUNNING`, or `DONE`.
1765 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
1766 # operation.
1767 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
1768 # of the target resource.
1769 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
1770 # operations related to creating a snapshot, this points to the disk
1771 # that the snapshot was created from.
1772 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
1773 # `[email protected]` or
1774 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
1775 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
1776 # operation, this field will be populated.
1777 {
1778 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
1779 # Engine returns NO_RESULTS_ON_PAGE if there
1780 # are no results in the response.
1781 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
1782 # value format. For example:
1783 #
1784 # &quot;data&quot;: [
1785 # {
1786 # &quot;key&quot;: &quot;scope&quot;,
1787 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
1788 # }
1789 {
1790 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
1791 # returned. For example, for warnings where there are no results in a list
1792 # request for a particular zone, this key might be scope and
1793 # the key value might be the zone name. Other examples might be a key
1794 # indicating a deprecated resource and a suggested replacement, or a
1795 # warning about invalid network settings (for example, if an instance
1796 # attempts to perform IP forwarding but is not enabled for IP forwarding).
1797 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
1798 },
1799 ],
1800 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
1801 },
1802 ],
1803 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
1804 # applicable when performing per-zone operations.
1805 }</pre>
1806 </div>
1807
1808 <div class="method">
1809 <code class="details" id="close">close()</code>
1810 <pre>Close httplib2 connections.</pre>
1811 </div>
1812
1813 <div class="method">
1814 <code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body=None, guestFlush=None, requestId=None, x__xgafv=None)</code>
1815 <pre>Creates a snapshot of a specified persistent disk. For regular snapshot
1816 creation, consider using snapshots.insert
1817 instead, as that method supports more features, such as creating snapshots
1818 in a project different from the source disk project.
1819
1820 Args:
1821 project: string, Project ID for this request. (required)
1822 zone: string, The name of the zone for this request. (required)
1823 disk: string, Name of the persistent disk to snapshot. (required)
1824 body: object, The request body.
1825 The object takes the form of:
1826
1827 { # Represents a Persistent Disk Snapshot resource.
1828 #
1829 # You can use snapshots to back up data on a regular interval. For more
1830 # information, read Creating
1831 # persistent disk snapshots.
1832 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1833 # ARM64 or X86_64.
1834 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1835 # applying resource policy on the target disk.
1836 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1837 # specified name. The chain name must be 1-63 characters long and comply
1838 # with RFC1035. This is an uncommon option only for advanced service
1839 # owners who needs to create separate snapshot chains, for example,
1840 # for chargeback tracking. When you describe your snapshot resource, this
1841 # field is visible only if it has a non-empty value.
1842 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1843 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1844 # text format.
1845 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1846 # create the resource.
1847 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1848 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1849 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1850 # [Output Only]: This field is not set by user, but from source disk.
1851 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
1852 # informing the OS to prepare for the snapshot process.
1853 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1854 # Applicable only for bootable images. Read
1855 # Enabling guest operating system features to see a list of available
1856 # options.
1857 { # Guest OS features.
1858 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1859 # separate values. Set to one or more of the following values:
1860 #
1861 # - VIRTIO_SCSI_MULTIQUEUE
1862 # - WINDOWS
1863 # - MULTI_IP_SUBNET
1864 # - UEFI_COMPATIBLE
1865 # - GVNIC
1866 # - SEV_CAPABLE
1867 # - SUSPEND_RESUME_COMPATIBLE
1868 # - SEV_LIVE_MIGRATABLE_V2
1869 # - SEV_SNP_CAPABLE
1870 # - TDX_CAPABLE
1871 # - IDPF
1872 # - SNP_SVSM_CAPABLE
1873 # - CCA_CAPABLE
1874 #
1875 #
1876 # For more information, see
1877 # Enabling guest operating system features.
1878 },
1879 ],
1880 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1881 # defined by the server.
1882 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1883 # for Snapshot resources.
1884 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1885 # essentially a hash of the labels set used for optimistic locking. The
1886 # fingerprint is initially generated by Compute Engine and changes after
1887 # every request to modify or update labels. You must always provide an
1888 # up-to-date fingerprint hash in order to update or change labels,
1889 # otherwise the request will fail with error412 conditionNotMet.
1890 #
1891 # To see the latest fingerprint, make a get() request to
1892 # retrieve a snapshot.
1893 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1894 # the setLabels method.
1895 # Label values may be empty.
1896 &quot;a_key&quot;: &quot;A String&quot;,
1897 },
1898 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1899 # to this snapshot.
1900 &quot;A String&quot;,
1901 ],
1902 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1903 # snapshot. This can be because the original image had licenses attached
1904 # (such as a Windows image).
1905 &quot;A String&quot;,
1906 ],
1907 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
1908 # resources.
1909 # This field is for use by internal tools that use the public API.
1910 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1911 # The name must be 1-63 characters long, and comply withRFC1035.
1912 # Specifically, the name must be 1-63 characters long and match the regular
1913 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1914 # character must be a lowercase letter, and all following characters must be
1915 # a dash, lowercase letter, or digit, except the last character, which cannot
1916 # be a dash.
1917 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1918 # as part of resource payload.
1919 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
1920 # the same definition as resource
1921 # manager tags. Keys and values can be either in numeric format,
1922 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1923 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1924 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1925 # PATCH) when empty.
1926 &quot;a_key&quot;: &quot;A String&quot;,
1927 },
1928 },
1929 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
1930 # for regional snapshots.
1931 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1932 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1933 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1934 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1935 # encryption key.
1936 #
1937 # After you encrypt a snapshot using a customer-supplied key, you must
1938 # provide the same key if you use the snapshot later. For example, you must
1939 # provide the encryption key when you create a disk from the encrypted
1940 # snapshot in a future request.
1941 #
1942 # Customer-supplied encryption keys do not protect access to metadata
1943 # of the snapshot.
1944 #
1945 # If you do not provide an encryption key when creating the snapshot, then
1946 # the snapshot will be encrypted using an automatically generated key and you
1947 # do not need to provide a key to use the snapshot later.
1948 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1949 # For example:
1950 #
1951 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1952 # key_region/cryptoKeys/key
1953 #
1954 # The fully-qualifed key name may be returned for resource GET requests. For
1955 # example:
1956 #
1957 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1958 # key_region/cryptoKeys/key
1959 # /cryptoKeyVersions/1
1960 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1961 # key. If absent, the Compute Engine default service account is used.
1962 # For example:
1963 #
1964 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1965 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1966 # encryption key, encoded in RFC
1967 # 4648 base64 to either encrypt or decrypt this resource. You can
1968 # provide either the rawKey or thersaEncryptedKey.
1969 # For example:
1970 #
1971 # &quot;rawKey&quot;:
1972 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1973 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1974 # customer-supplied encryption key to either encrypt or decrypt this
1975 # resource. You can provide either the rawKey or thersaEncryptedKey.
1976 # For example:
1977 #
1978 # &quot;rsaEncryptedKey&quot;:
1979 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1980 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1981 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1982 #
1983 # The key must meet the following requirements before you can provide it to
1984 # Compute Engine:
1985 #
1986 # 1. The key is wrapped using a RSA public key certificate provided by
1987 # Google.
1988 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1989 # encoding.
1990 #
1991 # Gets the RSA public key certificate provided by Google at:
1992 #
1993 #
1994 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1995 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1996 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1997 # encryption key that protects this resource.
1998 },
1999 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
2000 # belongs to. The usage of snapshot group feature is restricted.
2001 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
2002 # of snapshot group feature is restricted.
2003 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
2004 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
2005 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
2006 # encryption key of the source disk. Required if the source disk is
2007 # protected by a customer-supplied encryption key.
2008 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2009 # For example:
2010 #
2011 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2012 # key_region/cryptoKeys/key
2013 #
2014 # The fully-qualifed key name may be returned for resource GET requests. For
2015 # example:
2016 #
2017 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2018 # key_region/cryptoKeys/key
2019 # /cryptoKeyVersions/1
2020 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2021 # key. If absent, the Compute Engine default service account is used.
2022 # For example:
2023 #
2024 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2025 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2026 # encryption key, encoded in RFC
2027 # 4648 base64 to either encrypt or decrypt this resource. You can
2028 # provide either the rawKey or thersaEncryptedKey.
2029 # For example:
2030 #
2031 # &quot;rawKey&quot;:
2032 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2033 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2034 # customer-supplied encryption key to either encrypt or decrypt this
2035 # resource. You can provide either the rawKey or thersaEncryptedKey.
2036 # For example:
2037 #
2038 # &quot;rsaEncryptedKey&quot;:
2039 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2040 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2041 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2042 #
2043 # The key must meet the following requirements before you can provide it to
2044 # Compute Engine:
2045 #
2046 # 1. The key is wrapped using a RSA public key certificate provided by
2047 # Google.
2048 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2049 # encoding.
2050 #
2051 # Gets the RSA public key certificate provided by Google at:
2052 #
2053 #
2054 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2055 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2056 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2057 # encryption key that protects this resource.
2058 },
2059 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
2060 # snapshot.
2061 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
2062 # value may be used to determine whether the snapshot was taken from the
2063 # current or a previous instance of a given disk name.
2064 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
2065 # this as a partial or full URL to the resource. For example, the following
2066 # are valid values:
2067 #
2068 #
2069 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
2070 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
2071 # - zones/zone/instantSnapshots/instantSnapshot
2072 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
2073 # Snapshot.
2074 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2075 # For example:
2076 #
2077 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2078 # key_region/cryptoKeys/key
2079 #
2080 # The fully-qualifed key name may be returned for resource GET requests. For
2081 # example:
2082 #
2083 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2084 # key_region/cryptoKeys/key
2085 # /cryptoKeyVersions/1
2086 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2087 # key. If absent, the Compute Engine default service account is used.
2088 # For example:
2089 #
2090 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2091 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2092 # encryption key, encoded in RFC
2093 # 4648 base64 to either encrypt or decrypt this resource. You can
2094 # provide either the rawKey or thersaEncryptedKey.
2095 # For example:
2096 #
2097 # &quot;rawKey&quot;:
2098 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2099 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2100 # customer-supplied encryption key to either encrypt or decrypt this
2101 # resource. You can provide either the rawKey or thersaEncryptedKey.
2102 # For example:
2103 #
2104 # &quot;rsaEncryptedKey&quot;:
2105 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2106 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2107 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2108 #
2109 # The key must meet the following requirements before you can provide it to
2110 # Compute Engine:
2111 #
2112 # 1. The key is wrapped using a RSA public key certificate provided by
2113 # Google.
2114 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2115 # encoding.
2116 #
2117 # Gets the RSA public key certificate provided by Google at:
2118 #
2119 #
2120 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2121 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2122 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2123 # encryption key that protects this resource.
2124 },
2125 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
2126 # snapshot. This value identifies the exact instant snapshot that was used to
2127 # create this snapshot. For example, if you created the snapshot from an
2128 # instant snapshot that was later deleted and recreated under the same name,
2129 # the source instant snapshot ID would identify the exact instant snapshot
2130 # that was used.
2131 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
2132 # scheduled snapshot.
2133 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
2134 # scheduled snapshot.
2135 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
2136 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
2137 # share storage, this number is expected to change with snapshot
2138 # creation/deletion.
2139 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
2140 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
2141 # [Output Only] An indicator whether storageBytes is in a
2142 # stable state or it is being adjusted as a result of shared storage
2143 # reallocation. This status can either be unset, meaning the snapshot is
2144 # being created, or UP_TO_DATE, meaning the size of the snapshot
2145 # is up-to-date.
2146 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
2147 # multi-regional).
2148 &quot;A String&quot;,
2149 ],
2150 }
2151
2152 guestFlush: boolean, [Input Only] Whether to attempt an application consistent snapshot by
2153 informing the OS to prepare for the snapshot process.
2154 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2155 that if you must retry your request, the server will know to ignore the
2156 request if it has already been completed.
2157
2158 For example, consider a situation where you make an initial request and
2159 the request times out. If you make the request again with the same
2160 request ID, the server can check if original operation with the same
2161 request ID was received, and if so, will ignore the second request. This
2162 prevents clients from accidentally creating duplicate commitments.
2163
2164 The request ID must be
2165 a valid UUID with the exception that zero UUID is not supported
2166 (00000000-0000-0000-0000-000000000000).
2167 x__xgafv: string, V1 error format.
2168 Allowed values
2169 1 - v1 error format
2170 2 - v2 error format
2171
2172 Returns:
2173 An object of the form:
2174
2175 { # Represents an Operation resource.
2176 #
2177 # Google Compute Engine has three Operation resources:
2178 #
2179 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2180 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2181 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2182 #
2183 # You can use an operation resource to manage asynchronous API requests.
2184 # For more information, readHandling
2185 # API responses.
2186 #
2187 # Operations can be global, regional or zonal.
2188 #
2189 # - For global operations, use the `globalOperations`
2190 # resource.
2191 # - For regional operations, use the
2192 # `regionOperations` resource.
2193 # - For zonal operations, use
2194 # the `zoneOperations` resource.
2195 #
2196 #
2197 #
2198 # For more information, read
2199 # Global, Regional, and Zonal Resources.
2200 #
2201 # Note that completed Operation resources have a limited
2202 # retention period.
2203 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2204 # Not present otherwise.
2205 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2206 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2207 # set when the operation is created.
2208 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2209 # text format.
2210 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2211 # this field will be populated.
2212 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2213 # operation.
2214 {
2215 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2216 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2217 # details. There is a set of defined message types to use for providing
2218 # details.The syntax depends on the error code. For example,
2219 # QuotaExceededInfo will have details when the error code is
2220 # QUOTA_EXCEEDED.
2221 {
2222 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2223 #
2224 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2225 # is not enabled:
2226 #
2227 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2228 # &quot;domain&quot;: &quot;googleapis.com&quot;
2229 # &quot;metadata&quot;: {
2230 # &quot;resource&quot;: &quot;projects/123&quot;,
2231 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2232 # }
2233 # }
2234 #
2235 # This response indicates that the pubsub.googleapis.com API is not enabled.
2236 #
2237 # Example of an error that is returned when attempting to create a Spanner
2238 # instance in a region that is out of stock:
2239 #
2240 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2241 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2242 # &quot;metadata&quot;: {
2243 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2244 # }
2245 # }
2246 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2247 # is typically the registered service name of the tool or product that
2248 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2249 # generated by some common infrastructure, the error domain must be a
2250 # globally unique value that identifies the infrastructure. For Google API
2251 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2252 &quot;metadatas&quot;: { # Additional structured details about this error.
2253 #
2254 # Keys must match a regular expression of `a-z+` but should
2255 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2256 # length. When identifying the current value of an exceeded limit, the units
2257 # should be contained in the key, not the value. For example, rather than
2258 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2259 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2260 # instances that can be created in a single (batch) request.
2261 &quot;a_key&quot;: &quot;A String&quot;,
2262 },
2263 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2264 # proximate cause of the error. Error reasons are unique within a particular
2265 # domain of errors. This should be at most 63 characters and match a
2266 # regular expression of `A-Z+[A-Z0-9]`, which represents
2267 # UPPER_SNAKE_CASE.
2268 },
2269 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2270 #
2271 # For example, if a quota check failed with an error indicating the calling
2272 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2273 # directly to the right place in the developer console to flip the bit.
2274 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2275 { # Describes a URL link.
2276 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2277 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2278 },
2279 ],
2280 },
2281 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2282 # which can be attached to an RPC error.
2283 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2284 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2285 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2286 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2287 },
2288 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2289 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2290 &quot;a_key&quot;: &quot;A String&quot;,
2291 },
2292 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2293 # type or metric.
2294 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2295 # or metric.
2296 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2297 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2298 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2299 },
2300 },
2301 ],
2302 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2303 # This property is optional.
2304 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2305 },
2306 ],
2307 },
2308 &quot;getVersionOperationMetadata&quot;: {
2309 &quot;inlineSbomInfo&quot;: {
2310 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2311 # appropriate identifiers.
2312 &quot;a_key&quot;: &quot;A String&quot;,
2313 },
2314 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2315 # identifiers.
2316 &quot;a_key&quot;: &quot;A String&quot;,
2317 },
2318 },
2319 },
2320 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2321 # message that was returned, such as `NOT FOUND`.
2322 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2323 # status code that was returned. For example, a `404` means the
2324 # resource was not found.
2325 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2326 # defined by the server.
2327 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2328 # This value is inRFC3339
2329 # text format.
2330 &quot;instancesBulkInsertOperationMetadata&quot;: {
2331 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2332 # Example key: zones/us-central1-a
2333 &quot;a_key&quot;: {
2334 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2335 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2336 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2337 # error.
2338 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2339 # if the flow is rolling forward or rolling back.
2340 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2341 },
2342 },
2343 },
2344 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2345 # Operation resources.
2346 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2347 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2348 # group of operations results from a `bulkInsert` API request.
2349 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2350 # `update`, or `delete`, and so on.
2351 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2352 # There is no requirement that this be linear or support any granularity of
2353 # operations. This should not be used to guess when the operation will be
2354 # complete. This number should monotonically increase as the operation
2355 # progresses.
2356 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2357 # applicable when performing regional operations.
2358 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2359 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2360 # this field will contain information on all underlying zonal actions and
2361 # their state.
2362 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2363 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2364 # Example key: zones/us-central1-a
2365 &quot;a_key&quot;: {
2366 &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
2367 # populated.
2368 # different programming environments, including REST APIs and RPC APIs. It is
2369 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2370 # three pieces of data: error code, error message, and error details.
2371 #
2372 # You can find out more about this error model and how to work with it in the
2373 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2374 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2375 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2376 # message types for APIs to use.
2377 {
2378 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2379 },
2380 ],
2381 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2382 # user-facing error message should be localized and sent in the
2383 # google.rpc.Status.details field, or localized by the client.
2384 },
2385 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2386 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2387 },
2388 },
2389 },
2390 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2391 # This value is inRFC3339
2392 # text format.
2393 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2394 # following:
2395 # `PENDING`, `RUNNING`, or `DONE`.
2396 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2397 # operation.
2398 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2399 # of the target resource.
2400 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2401 # operations related to creating a snapshot, this points to the disk
2402 # that the snapshot was created from.
2403 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2404 # `[email protected]` or
2405 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2406 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2407 # operation, this field will be populated.
2408 {
2409 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2410 # Engine returns NO_RESULTS_ON_PAGE if there
2411 # are no results in the response.
2412 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2413 # value format. For example:
2414 #
2415 # &quot;data&quot;: [
2416 # {
2417 # &quot;key&quot;: &quot;scope&quot;,
2418 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2419 # }
2420 {
2421 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2422 # returned. For example, for warnings where there are no results in a list
2423 # request for a particular zone, this key might be scope and
2424 # the key value might be the zone name. Other examples might be a key
2425 # indicating a deprecated resource and a suggested replacement, or a
2426 # warning about invalid network settings (for example, if an instance
2427 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2428 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2429 },
2430 ],
2431 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2432 },
2433 ],
2434 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2435 # applicable when performing per-zone operations.
2436 }</pre>
2437 </div>
2438
2439 <div class="method">
2440 <code class="details" id="delete">delete(project, zone, disk, requestId=None, x__xgafv=None)</code>
2441 <pre>Deletes the specified persistent disk. Deleting a disk removes its data
2442 permanently and is irreversible. However, deleting a disk does not
2443 delete any snapshots
2444 previously made from the disk. You must separatelydelete
2445 snapshots.
2446
2447 Args:
2448 project: string, Project ID for this request. (required)
2449 zone: string, The name of the zone for this request. (required)
2450 disk: string, Name of the persistent disk to delete. (required)
2451 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2452 that if you must retry your request, the server will know to ignore the
2453 request if it has already been completed.
2454
2455 For example, consider a situation where you make an initial request and
2456 the request times out. If you make the request again with the same
2457 request ID, the server can check if original operation with the same
2458 request ID was received, and if so, will ignore the second request. This
2459 prevents clients from accidentally creating duplicate commitments.
2460
2461 The request ID must be
2462 a valid UUID with the exception that zero UUID is not supported
2463 (00000000-0000-0000-0000-000000000000).
2464 x__xgafv: string, V1 error format.
2465 Allowed values
2466 1 - v1 error format
2467 2 - v2 error format
2468
2469 Returns:
2470 An object of the form:
2471
2472 { # Represents an Operation resource.
2473 #
2474 # Google Compute Engine has three Operation resources:
2475 #
2476 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
2477 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
2478 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
2479 #
2480 # You can use an operation resource to manage asynchronous API requests.
2481 # For more information, readHandling
2482 # API responses.
2483 #
2484 # Operations can be global, regional or zonal.
2485 #
2486 # - For global operations, use the `globalOperations`
2487 # resource.
2488 # - For regional operations, use the
2489 # `regionOperations` resource.
2490 # - For zonal operations, use
2491 # the `zoneOperations` resource.
2492 #
2493 #
2494 #
2495 # For more information, read
2496 # Global, Regional, and Zonal Resources.
2497 #
2498 # Note that completed Operation resources have a limited
2499 # retention period.
2500 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2501 # Not present otherwise.
2502 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2503 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2504 # set when the operation is created.
2505 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2506 # text format.
2507 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2508 # this field will be populated.
2509 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2510 # operation.
2511 {
2512 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2513 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2514 # details. There is a set of defined message types to use for providing
2515 # details.The syntax depends on the error code. For example,
2516 # QuotaExceededInfo will have details when the error code is
2517 # QUOTA_EXCEEDED.
2518 {
2519 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2520 #
2521 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2522 # is not enabled:
2523 #
2524 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2525 # &quot;domain&quot;: &quot;googleapis.com&quot;
2526 # &quot;metadata&quot;: {
2527 # &quot;resource&quot;: &quot;projects/123&quot;,
2528 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2529 # }
2530 # }
2531 #
2532 # This response indicates that the pubsub.googleapis.com API is not enabled.
2533 #
2534 # Example of an error that is returned when attempting to create a Spanner
2535 # instance in a region that is out of stock:
2536 #
2537 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2538 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2539 # &quot;metadata&quot;: {
2540 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2541 # }
2542 # }
2543 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2544 # is typically the registered service name of the tool or product that
2545 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2546 # generated by some common infrastructure, the error domain must be a
2547 # globally unique value that identifies the infrastructure. For Google API
2548 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2549 &quot;metadatas&quot;: { # Additional structured details about this error.
2550 #
2551 # Keys must match a regular expression of `a-z+` but should
2552 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2553 # length. When identifying the current value of an exceeded limit, the units
2554 # should be contained in the key, not the value. For example, rather than
2555 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2556 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2557 # instances that can be created in a single (batch) request.
2558 &quot;a_key&quot;: &quot;A String&quot;,
2559 },
2560 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2561 # proximate cause of the error. Error reasons are unique within a particular
2562 # domain of errors. This should be at most 63 characters and match a
2563 # regular expression of `A-Z+[A-Z0-9]`, which represents
2564 # UPPER_SNAKE_CASE.
2565 },
2566 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2567 #
2568 # For example, if a quota check failed with an error indicating the calling
2569 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2570 # directly to the right place in the developer console to flip the bit.
2571 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2572 { # Describes a URL link.
2573 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2574 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2575 },
2576 ],
2577 },
2578 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2579 # which can be attached to an RPC error.
2580 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2581 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2582 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2583 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2584 },
2585 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2586 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2587 &quot;a_key&quot;: &quot;A String&quot;,
2588 },
2589 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2590 # type or metric.
2591 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2592 # or metric.
2593 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2594 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2595 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2596 },
2597 },
2598 ],
2599 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2600 # This property is optional.
2601 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2602 },
2603 ],
2604 },
2605 &quot;getVersionOperationMetadata&quot;: {
2606 &quot;inlineSbomInfo&quot;: {
2607 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2608 # appropriate identifiers.
2609 &quot;a_key&quot;: &quot;A String&quot;,
2610 },
2611 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2612 # identifiers.
2613 &quot;a_key&quot;: &quot;A String&quot;,
2614 },
2615 },
2616 },
2617 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2618 # message that was returned, such as `NOT FOUND`.
2619 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2620 # status code that was returned. For example, a `404` means the
2621 # resource was not found.
2622 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2623 # defined by the server.
2624 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2625 # This value is inRFC3339
2626 # text format.
2627 &quot;instancesBulkInsertOperationMetadata&quot;: {
2628 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2629 # Example key: zones/us-central1-a
2630 &quot;a_key&quot;: {
2631 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2632 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2633 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2634 # error.
2635 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2636 # if the flow is rolling forward or rolling back.
2637 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2638 },
2639 },
2640 },
2641 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2642 # Operation resources.
2643 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2644 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2645 # group of operations results from a `bulkInsert` API request.
2646 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2647 # `update`, or `delete`, and so on.
2648 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2649 # There is no requirement that this be linear or support any granularity of
2650 # operations. This should not be used to guess when the operation will be
2651 # complete. This number should monotonically increase as the operation
2652 # progresses.
2653 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2654 # applicable when performing regional operations.
2655 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2656 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2657 # this field will contain information on all underlying zonal actions and
2658 # their state.
2659 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2660 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2661 # Example key: zones/us-central1-a
2662 &quot;a_key&quot;: {
2663 &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
2664 # populated.
2665 # different programming environments, including REST APIs and RPC APIs. It is
2666 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2667 # three pieces of data: error code, error message, and error details.
2668 #
2669 # You can find out more about this error model and how to work with it in the
2670 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2671 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2672 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2673 # message types for APIs to use.
2674 {
2675 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2676 },
2677 ],
2678 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2679 # user-facing error message should be localized and sent in the
2680 # google.rpc.Status.details field, or localized by the client.
2681 },
2682 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2683 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2684 },
2685 },
2686 },
2687 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2688 # This value is inRFC3339
2689 # text format.
2690 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2691 # following:
2692 # `PENDING`, `RUNNING`, or `DONE`.
2693 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2694 # operation.
2695 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2696 # of the target resource.
2697 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2698 # operations related to creating a snapshot, this points to the disk
2699 # that the snapshot was created from.
2700 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2701 # `[email protected]` or
2702 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2703 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2704 # operation, this field will be populated.
2705 {
2706 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2707 # Engine returns NO_RESULTS_ON_PAGE if there
2708 # are no results in the response.
2709 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2710 # value format. For example:
2711 #
2712 # &quot;data&quot;: [
2713 # {
2714 # &quot;key&quot;: &quot;scope&quot;,
2715 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2716 # }
2717 {
2718 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2719 # returned. For example, for warnings where there are no results in a list
2720 # request for a particular zone, this key might be scope and
2721 # the key value might be the zone name. Other examples might be a key
2722 # indicating a deprecated resource and a suggested replacement, or a
2723 # warning about invalid network settings (for example, if an instance
2724 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2725 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2726 },
2727 ],
2728 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2729 },
2730 ],
2731 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2732 # applicable when performing per-zone operations.
2733 }</pre>
2734 </div>
2735
2736 <div class="method">
2737 <code class="details" id="get">get(project, zone, disk, x__xgafv=None)</code>
2738 <pre>Returns the specified persistent disk.
2739
2740 Args:
2741 project: string, Project ID for this request. (required)
2742 zone: string, The name of the zone for this request. (required)
2743 disk: string, Name of the persistent disk to return. (required)
2744 x__xgafv: string, V1 error format.
2745 Allowed values
2746 1 - v1 error format
2747 2 - v2 error format
2748
2749 Returns:
2750 An object of the form:
2751
2752 { # Represents a Persistent Disk resource.
2753 #
2754 # Google Compute Engine has two Disk resources:
2755 #
2756 # * [Zonal](/compute/docs/reference/rest/v1/disks)
2757 # * [Regional](/compute/docs/reference/rest/v1/regionDisks)
2758 #
2759 # Persistent disks are required for running your VM instances.
2760 # Create both boot and non-boot (data) persistent disks. For more information,
2761 # read Persistent Disks. For more
2762 # storage options, read Storage options.
2763 #
2764 # The disks resource represents a zonal persistent disk.
2765 # For more information, readZonal persistent disks.
2766 #
2767 # The regionDisks resource represents a
2768 # regional persistent disk. For more information, read
2769 # Regional resources.
2770 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
2771 #
2772 #
2773 # - READ_WRITE_SINGLE: The default AccessMode, means the
2774 # disk can be attached to single instance in RW mode.
2775 # - READ_WRITE_MANY: The AccessMode means the disk can be
2776 # attached to multiple instances in RW mode.
2777 # - READ_ONLY_MANY: The AccessMode means the disk can be
2778 # attached to multiple instances in RO mode.
2779 #
2780 #
2781 # The AccessMode is only valid for Hyperdisk disk types.
2782 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
2783 # ARM64 or X86_64.
2784 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
2785 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
2786 # started on the disk as a member of a group.
2787 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
2788 # started on the disk as a member of a group.
2789 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
2790 # You can provide this as a partial or full URL to the resource.
2791 # For example, the following are valid values:
2792 #
2793 #
2794 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
2795 # - projects/project/zones/zone/disks/disk
2796 # - zones/zone/disks/disk
2797 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
2798 # to or from the current disk. This value identifies the exact disk that
2799 # was used to create this replication. For example, if you started
2800 # replicating the persistent disk from a disk that was later deleted and
2801 # recreated under the same name, the disk ID would identify the exact
2802 # version of the disk that was used.
2803 },
2804 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
2805 &quot;a_key&quot;: {
2806 &quot;asyncReplicationDisk&quot;: {
2807 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
2808 # started on the disk as a member of a group.
2809 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
2810 # started on the disk as a member of a group.
2811 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
2812 # You can provide this as a partial or full URL to the resource.
2813 # For example, the following are valid values:
2814 #
2815 #
2816 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
2817 # - projects/project/zones/zone/disks/disk
2818 # - zones/zone/disks/disk
2819 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
2820 # to or from the current disk. This value identifies the exact disk that
2821 # was used to create this replication. For example, if you started
2822 # replicating the persistent disk from a disk that was later deleted and
2823 # recreated under the same name, the disk ID would identify the exact
2824 # version of the disk that was used.
2825 },
2826 },
2827 },
2828 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2829 # text format.
2830 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2831 # create the resource.
2832 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
2833 # customer-supplied encryption key or a
2834 # customer-managed encryption key.
2835 #
2836 # Encryption keys do not protect access to metadata of the disk.
2837 #
2838 # After you encrypt a disk with a customer-supplied key, you must provide the
2839 # same key if you use the disk later. For example, to create a disk snapshot,
2840 # to create a disk image, to create a machine image, or to attach the disk to
2841 # a virtual machine.
2842 #
2843 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
2844 # name once the disk is created. The disk is encrypted with this version of
2845 # the key. In the response, diskEncryptionKey.kmsKeyName appears
2846 # in the following format:
2847 #
2848 # &quot;diskEncryptionKey.kmsKeyName&quot;:
2849 # &quot;projects/kms_project_id/locations/region/keyRings/
2850 # key_region/cryptoKeys/key
2851 # /cryptoKeysVersions/version
2852 #
2853 # If you do not provide an encryption key when creating the disk, then the
2854 # disk is encrypted using an automatically generated key and you don&#x27;t need
2855 # to provide a key to use the disk later.
2856 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2857 # For example:
2858 #
2859 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2860 # key_region/cryptoKeys/key
2861 #
2862 # The fully-qualifed key name may be returned for resource GET requests. For
2863 # example:
2864 #
2865 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2866 # key_region/cryptoKeys/key
2867 # /cryptoKeyVersions/1
2868 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2869 # key. If absent, the Compute Engine default service account is used.
2870 # For example:
2871 #
2872 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2873 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2874 # encryption key, encoded in RFC
2875 # 4648 base64 to either encrypt or decrypt this resource. You can
2876 # provide either the rawKey or thersaEncryptedKey.
2877 # For example:
2878 #
2879 # &quot;rawKey&quot;:
2880 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2881 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2882 # customer-supplied encryption key to either encrypt or decrypt this
2883 # resource. You can provide either the rawKey or thersaEncryptedKey.
2884 # For example:
2885 #
2886 # &quot;rsaEncryptedKey&quot;:
2887 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2888 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2889 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2890 #
2891 # The key must meet the following requirements before you can provide it to
2892 # Compute Engine:
2893 #
2894 # 1. The key is wrapped using a RSA public key certificate provided by
2895 # Google.
2896 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2897 # encoding.
2898 #
2899 # Gets the RSA public key certificate provided by Google at:
2900 #
2901 #
2902 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2903 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2904 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2905 # encryption key that protects this resource.
2906 },
2907 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
2908 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
2909 # only for bootable images. Read
2910 # Enabling guest operating system features to see a list of available
2911 # options.
2912 { # Guest OS features.
2913 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
2914 # separate values. Set to one or more of the following values:
2915 #
2916 # - VIRTIO_SCSI_MULTIQUEUE
2917 # - WINDOWS
2918 # - MULTI_IP_SUBNET
2919 # - UEFI_COMPATIBLE
2920 # - GVNIC
2921 # - SEV_CAPABLE
2922 # - SUSPEND_RESUME_COMPATIBLE
2923 # - SEV_LIVE_MIGRATABLE_V2
2924 # - SEV_SNP_CAPABLE
2925 # - TDX_CAPABLE
2926 # - IDPF
2927 # - SNP_SVSM_CAPABLE
2928 # - CCA_CAPABLE
2929 #
2930 #
2931 # For more information, see
2932 # Enabling guest operating system features.
2933 },
2934 ],
2935 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2936 # defined by the server.
2937 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
2938 # disks.
2939 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
2940 # essentially a hash of the labels set used for optimistic locking. The
2941 # fingerprint is initially generated by Compute Engine and changes after
2942 # every request to modify or update labels. You must always provide an
2943 # up-to-date fingerprint hash in order to update or change labels,
2944 # otherwise the request will fail with error412 conditionNotMet.
2945 #
2946 # To see the latest fingerprint, make a get() request to
2947 # retrieve a disk.
2948 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
2949 # the setLabels method.
2950 &quot;a_key&quot;: &quot;A String&quot;,
2951 },
2952 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
2953 # text format.
2954 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
2955 # text format.
2956 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
2957 &quot;A String&quot;,
2958 ],
2959 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
2960 &quot;A String&quot;,
2961 ],
2962 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
2963 # This field is for use by internal tools that use the public API.
2964 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
2965 # The name must be 1-63 characters long, and comply withRFC1035.
2966 # Specifically, the name must be 1-63 characters long and match the regular
2967 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
2968 # which means the first character must be a lowercase letter, and all
2969 # following characters must be a dash, lowercase letter, or digit, except
2970 # the last character, which cannot be a dash.
2971 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
2972 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2973 # as part of resource payload.
2974 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
2975 # have the same definition as resource
2976 # manager tags. Keys and values can be either in numeric format,
2977 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2978 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2979 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2980 # PATCH) when empty.
2981 &quot;a_key&quot;: &quot;A String&quot;,
2982 },
2983 },
2984 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
2985 # If not present in a request, a default value is used.
2986 # The currently supported size is 4096, other sizes may be added in
2987 # the future.
2988 # If an unsupported value is requested, the error message will list
2989 # the supported values for the caller&#x27;s project.
2990 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
2991 # of I/O operations per second that the disk can handle. Values must be
2992 # between 10,000 and 120,000. For more details, see theExtreme persistent
2993 # disk documentation.
2994 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
2995 # number of throughput mb per second that the disk can handle. Values must be
2996 # greater than or equal to 1.
2997 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
2998 # regional resources.
2999 # You must specify this field as part of the HTTP request URL. It is
3000 # not settable as a field in the request body.
3001 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
3002 # for regional resources.
3003 &quot;A String&quot;,
3004 ],
3005 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3006 &quot;A String&quot;,
3007 ],
3008 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
3009 &quot;asyncPrimaryDisk&quot;: {
3010 &quot;state&quot;: &quot;A String&quot;,
3011 },
3012 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
3013 &quot;a_key&quot;: {
3014 &quot;state&quot;: &quot;A String&quot;,
3015 },
3016 },
3017 },
3018 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3019 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
3020 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
3021 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
3022 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
3023 # persistent disk.
3024 #
3025 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
3026 # source.
3027 # Acceptable values are greater than 0.
3028 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
3029 # that was created using a consistency group.
3030 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
3031 # that was created using a consistency group.
3032 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
3033 # partial or full URL to the resource. For example, the following are valid
3034 # values:
3035 #
3036 #
3037 # -
3038 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3039 #
3040 # -
3041 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
3042 #
3043 # -
3044 # projects/project/zones/zone/disks/disk
3045 #
3046 # -
3047 # projects/project/regions/region/disks/disk
3048 #
3049 # -
3050 # zones/zone/disks/disk
3051 #
3052 # -
3053 # regions/region/disks/disk
3054 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
3055 # value identifies the exact disk that was used to create this persistent
3056 # disk. For example, if you created the persistent disk from a disk that
3057 # was later deleted and recreated under the same name, the source disk ID
3058 # would identify the exact version of the disk that was used.
3059 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
3060 # deleted, this field will not be set.
3061 #
3062 # To create a disk with one of the public operating system images, specify
3063 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3064 #
3065 # projects/debian-cloud/global/images/family/debian-9
3066 #
3067 #
3068 # Alternatively, use a specific version of a public operating system image:
3069 #
3070 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3071 #
3072 #
3073 # To create a disk with a custom image that you created, specify the
3074 # image name in the following format:
3075 #
3076 # global/images/my-custom-image
3077 #
3078 #
3079 # You can also specify a custom image by its image family, which returns
3080 # the latest version of the image in that family. Replace the image name
3081 # with family/family-name:
3082 #
3083 # global/images/family/my-image-family
3084 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3085 # encryption key of the source image. Required if the source image is
3086 # protected by a customer-supplied encryption key.
3087 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3088 # For example:
3089 #
3090 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3091 # key_region/cryptoKeys/key
3092 #
3093 # The fully-qualifed key name may be returned for resource GET requests. For
3094 # example:
3095 #
3096 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3097 # key_region/cryptoKeys/key
3098 # /cryptoKeyVersions/1
3099 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3100 # key. If absent, the Compute Engine default service account is used.
3101 # For example:
3102 #
3103 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3104 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3105 # encryption key, encoded in RFC
3106 # 4648 base64 to either encrypt or decrypt this resource. You can
3107 # provide either the rawKey or thersaEncryptedKey.
3108 # For example:
3109 #
3110 # &quot;rawKey&quot;:
3111 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3112 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3113 # customer-supplied encryption key to either encrypt or decrypt this
3114 # resource. You can provide either the rawKey or thersaEncryptedKey.
3115 # For example:
3116 #
3117 # &quot;rsaEncryptedKey&quot;:
3118 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3119 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3120 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3121 #
3122 # The key must meet the following requirements before you can provide it to
3123 # Compute Engine:
3124 #
3125 # 1. The key is wrapped using a RSA public key certificate provided by
3126 # Google.
3127 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3128 # encoding.
3129 #
3130 # Gets the RSA public key certificate provided by Google at:
3131 #
3132 #
3133 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3134 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3135 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3136 # encryption key that protects this resource.
3137 },
3138 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
3139 # value identifies the exact image that was used to create this persistent
3140 # disk. For example, if you created the persistent disk from an image that
3141 # was later deleted and recreated under the same name, the source image ID
3142 # would identify the exact version of the image that was used.
3143 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
3144 # this as a partial or full URL to the resource. For example, the following
3145 # are valid values:
3146 #
3147 #
3148 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
3149 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
3150 # - zones/zone/instantSnapshots/instantSnapshot
3151 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
3152 # disk. This value identifies the exact instant snapshot that was used to
3153 # create this persistent disk. For example, if you created the persistent
3154 # disk from an instant snapshot that was later deleted and recreated under
3155 # the same name, the source instant snapshot ID would identify the exact
3156 # version of the instant snapshot that was used.
3157 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
3158 # partial or full URL to the resource. For example, the following are valid
3159 # values:
3160 #
3161 #
3162 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
3163 # - projects/project/global/snapshots/snapshot
3164 # - global/snapshots/snapshot
3165 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
3166 # encryption key of the source snapshot. Required if the source snapshot
3167 # is protected by a customer-supplied encryption key.
3168 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3169 # For example:
3170 #
3171 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3172 # key_region/cryptoKeys/key
3173 #
3174 # The fully-qualifed key name may be returned for resource GET requests. For
3175 # example:
3176 #
3177 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3178 # key_region/cryptoKeys/key
3179 # /cryptoKeyVersions/1
3180 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3181 # key. If absent, the Compute Engine default service account is used.
3182 # For example:
3183 #
3184 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3185 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3186 # encryption key, encoded in RFC
3187 # 4648 base64 to either encrypt or decrypt this resource. You can
3188 # provide either the rawKey or thersaEncryptedKey.
3189 # For example:
3190 #
3191 # &quot;rawKey&quot;:
3192 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3193 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3194 # customer-supplied encryption key to either encrypt or decrypt this
3195 # resource. You can provide either the rawKey or thersaEncryptedKey.
3196 # For example:
3197 #
3198 # &quot;rsaEncryptedKey&quot;:
3199 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3200 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3201 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3202 #
3203 # The key must meet the following requirements before you can provide it to
3204 # Compute Engine:
3205 #
3206 # 1. The key is wrapped using a RSA public key certificate provided by
3207 # Google.
3208 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3209 # encoding.
3210 #
3211 # Gets the RSA public key certificate provided by Google at:
3212 #
3213 #
3214 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3215 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3216 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3217 # encryption key that protects this resource.
3218 },
3219 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
3220 # value identifies the exact snapshot that was used to create this persistent
3221 # disk. For example, if you created the persistent disk from a snapshot that
3222 # was later deleted and recreated under the same name, the source snapshot ID
3223 # would identify the exact version of the snapshot that was used.
3224 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
3225 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
3226 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
3227 # https://storage.googleapis.com/. This flag is not optimized for creating
3228 # multiple disks from a source storage object. To create many disks from a
3229 # source storage object, use gcloud compute images
3230 # import instead.
3231 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
3232 #
3233 #
3234 # - CREATING: Disk is provisioning.
3235 # - RESTORING: Source data is being copied into the
3236 # disk.
3237 # - FAILED: Disk creation failed.
3238 # - READY: Disk is ready for use.
3239 # - DELETING: Disk is deleting.
3240 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
3241 # this as a partial or full URL to the resource. For example, the following
3242 # are valid values:
3243 #
3244 #
3245 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
3246 # - projects/project/zones/zone/storagePools/storagePool
3247 # - zones/zone/storagePools/storagePool
3248 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
3249 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
3250 # types.
3251 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
3252 # in form:projects/project/zones/zone/instances/instance
3253 &quot;A String&quot;,
3254 ],
3255 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
3256 # You must specify this field as part of the HTTP request URL. It is
3257 # not settable as a field in the request body.
3258 }</pre>
3259 </div>
3260
3261 <div class="method">
3262 <code class="details" id="getIamPolicy">getIamPolicy(project, zone, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
3263 <pre>Gets the access control policy for a resource. May be empty if no such
3264 policy or resource exists.
3265
3266 Args:
3267 project: string, Project ID for this request. (required)
3268 zone: string, The name of the zone for this request. (required)
3269 resource: string, Name or id of the resource for this request. (required)
3270 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
3271 x__xgafv: string, V1 error format.
3272 Allowed values
3273 1 - v1 error format
3274 2 - v2 error format
3275
3276 Returns:
3277 An object of the form:
3278
3279 { # An Identity and Access Management (IAM) policy, which specifies access
3280 # controls for Google Cloud resources.
3281 #
3282 #
3283 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3284 # `members`, or principals, to a single `role`. Principals can be user
3285 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3286 # `role` is a named list of permissions; each `role` can be an IAM predefined
3287 # role or a user-created custom role.
3288 #
3289 # For some types of Google Cloud resources, a `binding` can also specify a
3290 # `condition`, which is a logical expression that allows access to a resource
3291 # only if the expression evaluates to `true`. A condition can add constraints
3292 # based on attributes of the request, the resource, or both. To learn which
3293 # resources support conditions in their IAM policies, see the
3294 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3295 #
3296 # **JSON example:**
3297 #
3298 # ```
3299 # {
3300 # &quot;bindings&quot;: [
3301 # {
3302 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3303 # &quot;members&quot;: [
3304 # &quot;user:[email protected]&quot;,
3305 # &quot;group:[email protected]&quot;,
3306 # &quot;domain:google.com&quot;,
3307 # &quot;serviceAccount:[email protected]&quot;
3308 # ]
3309 # },
3310 # {
3311 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3312 # &quot;members&quot;: [
3313 # &quot;user:[email protected]&quot;
3314 # ],
3315 # &quot;condition&quot;: {
3316 # &quot;title&quot;: &quot;expirable access&quot;,
3317 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3318 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3319 # }
3320 # }
3321 # ],
3322 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3323 # &quot;version&quot;: 3
3324 # }
3325 # ```
3326 #
3327 # **YAML example:**
3328 #
3329 # ```
3330 # bindings:
3331 # - members:
3332 # - user:[email protected]
3333 # - group:[email protected]
3334 # - domain:google.com
3335 # - serviceAccount:[email protected]
3336 # role: roles/resourcemanager.organizationAdmin
3337 # - members:
3338 # - user:[email protected]
3339 # role: roles/resourcemanager.organizationViewer
3340 # condition:
3341 # title: expirable access
3342 # description: Does not grant access after Sep 2020
3343 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3344 # etag: BwWWja0YfJA=
3345 # version: 3
3346 # ```
3347 #
3348 # For a description of IAM and its features, see the
3349 # [IAM documentation](https://cloud.google.com/iam/docs/).
3350 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3351 { # Specifies the audit configuration for a service.
3352 # The configuration determines which permission types are logged, and what
3353 # identities, if any, are exempted from logging.
3354 # An AuditConfig must have one or more AuditLogConfigs.
3355 #
3356 # If there are AuditConfigs for both `allServices` and a specific service,
3357 # the union of the two AuditConfigs is used for that service: the log_types
3358 # specified in each AuditConfig are enabled, and the exempted_members in each
3359 # AuditLogConfig are exempted.
3360 #
3361 # Example Policy with multiple AuditConfigs:
3362 #
3363 # {
3364 # &quot;audit_configs&quot;: [
3365 # {
3366 # &quot;service&quot;: &quot;allServices&quot;,
3367 # &quot;audit_log_configs&quot;: [
3368 # {
3369 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3370 # &quot;exempted_members&quot;: [
3371 # &quot;user:[email protected]&quot;
3372 # ]
3373 # },
3374 # {
3375 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3376 # },
3377 # {
3378 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3379 # }
3380 # ]
3381 # },
3382 # {
3383 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3384 # &quot;audit_log_configs&quot;: [
3385 # {
3386 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3387 # },
3388 # {
3389 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3390 # &quot;exempted_members&quot;: [
3391 # &quot;user:[email protected]&quot;
3392 # ]
3393 # }
3394 # ]
3395 # }
3396 # ]
3397 # }
3398 #
3399 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3400 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3401 # `[email protected]` from DATA_WRITE logging.
3402 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3403 { # Provides the configuration for logging a type of permissions.
3404 # Example:
3405 #
3406 # {
3407 # &quot;audit_log_configs&quot;: [
3408 # {
3409 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3410 # &quot;exempted_members&quot;: [
3411 # &quot;user:[email protected]&quot;
3412 # ]
3413 # },
3414 # {
3415 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3416 # }
3417 # ]
3418 # }
3419 #
3420 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3421 # [email protected] from DATA_READ logging.
3422 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3423 # permission.
3424 # Follows the same format of Binding.members.
3425 &quot;A String&quot;,
3426 ],
3427 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3428 },
3429 ],
3430 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3431 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3432 # `allServices` is a special value that covers all services.
3433 },
3434 ],
3435 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3436 # may specify a `condition` that determines how and when the `bindings` are
3437 # applied. Each of the `bindings` must contain at least one principal.
3438 #
3439 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3440 # of these principals can be Google groups. Each occurrence of a principal
3441 # counts towards these limits. For example, if the `bindings` grant 50
3442 # different roles to `user:[email protected]`, and not to any other
3443 # principal, then you can add another 1,450 principals to the `bindings` in
3444 # the `Policy`.
3445 { # Associates `members`, or principals, with a `role`.
3446 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3447 #
3448 # If the condition evaluates to `true`, then this binding applies to the
3449 # current request.
3450 #
3451 # If the condition evaluates to `false`, then this binding does not apply to
3452 # the current request. However, a different role binding might grant the same
3453 # role to one or more of the principals in this binding.
3454 #
3455 # To learn which resources support conditions in their IAM policies, see the
3456 # [IAM
3457 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3458 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3459 # are documented at https://github.com/google/cel-spec.
3460 #
3461 # Example (Comparison):
3462 #
3463 # title: &quot;Summary size limit&quot;
3464 # description: &quot;Determines if a summary is less than 100 chars&quot;
3465 # expression: &quot;document.summary.size() &lt; 100&quot;
3466 #
3467 # Example (Equality):
3468 #
3469 # title: &quot;Requestor is owner&quot;
3470 # description: &quot;Determines if requestor is the document owner&quot;
3471 # expression: &quot;document.owner == request.auth.claims.email&quot;
3472 #
3473 # Example (Logic):
3474 #
3475 # title: &quot;Public documents&quot;
3476 # description: &quot;Determine whether the document should be publicly visible&quot;
3477 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3478 #
3479 # Example (Data Manipulation):
3480 #
3481 # title: &quot;Notification string&quot;
3482 # description: &quot;Create a notification string with a timestamp.&quot;
3483 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3484 #
3485 # The exact variables and functions that may be referenced within an expression
3486 # are determined by the service that evaluates it. See the service
3487 # documentation for additional information.
3488 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3489 # describes the expression, e.g. when hovered over it in a UI.
3490 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3491 # syntax.
3492 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3493 # reporting, e.g. a file name and a position in the file.
3494 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3495 # its purpose. This can be used e.g. in UIs which allow to enter the
3496 # expression.
3497 },
3498 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3499 # `members` can have the following values:
3500 #
3501 # * `allUsers`: A special identifier that represents anyone who is
3502 # on the internet; with or without a Google account.
3503 #
3504 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3505 # who is authenticated with a Google account or a service account.
3506 # Does not include identities that come from external identity providers
3507 # (IdPs) through identity federation.
3508 #
3509 # * `user:{emailid}`: An email address that represents a specific Google
3510 # account. For example, `[email protected]` .
3511 #
3512 #
3513 # * `serviceAccount:{emailid}`: An email address that represents a Google
3514 # service account. For example,
3515 # `[email protected]`.
3516 #
3517 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3518 # identifier for a
3519 # [Kubernetes service
3520 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3521 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3522 #
3523 # * `group:{emailid}`: An email address that represents a Google group.
3524 # For example, `[email protected]`.
3525 #
3526 #
3527 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3528 # users of that domain. For example, `google.com` or `example.com`.
3529 #
3530 #
3531 #
3532 #
3533 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3534 # A single identity in a workforce identity pool.
3535 #
3536 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3537 # All workforce identities in a group.
3538 #
3539 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3540 # All workforce identities with a specific attribute value.
3541 #
3542 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3543 # All identities in a workforce identity pool.
3544 #
3545 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3546 # A single identity in a workload identity pool.
3547 #
3548 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3549 # A workload identity pool group.
3550 #
3551 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3552 # All identities in a workload identity pool with a certain attribute.
3553 #
3554 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3555 # All identities in a workload identity pool.
3556 #
3557 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3558 # identifier) representing a user that has been recently deleted. For
3559 # example, `[email protected]?uid=123456789012345678901`. If the user is
3560 # recovered, this value reverts to `user:{emailid}` and the recovered user
3561 # retains the role in the binding.
3562 #
3563 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3564 # unique identifier) representing a service account that has been recently
3565 # deleted. For example,
3566 # `[email protected]?uid=123456789012345678901`.
3567 # If the service account is undeleted, this value reverts to
3568 # `serviceAccount:{emailid}` and the undeleted service account retains the
3569 # role in the binding.
3570 #
3571 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3572 # identifier) representing a Google group that has been recently
3573 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3574 # the group is recovered, this value reverts to `group:{emailid}` and the
3575 # recovered group retains the role in the binding.
3576 #
3577 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3578 # Deleted single identity in a workforce identity pool. For example,
3579 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3580 &quot;A String&quot;,
3581 ],
3582 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3583 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3584 #
3585 # For an overview of the IAM roles and permissions, see the
3586 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3587 # a list of the available pre-defined roles, see
3588 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3589 },
3590 ],
3591 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3592 # prevent simultaneous updates of a policy from overwriting each other.
3593 # It is strongly suggested that systems make use of the `etag` in the
3594 # read-modify-write cycle to perform policy updates in order to avoid race
3595 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3596 # systems are expected to put that etag in the request to `setIamPolicy` to
3597 # ensure that their change will be applied to the same version of the policy.
3598 #
3599 # **Important:** If you use IAM Conditions, you must include the `etag` field
3600 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3601 # you to overwrite a version `3` policy with a version `1` policy, and all of
3602 # the conditions in the version `3` policy are lost.
3603 &quot;version&quot;: 42, # Specifies the format of the policy.
3604 #
3605 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3606 # are rejected.
3607 #
3608 # Any operation that affects conditional role bindings must specify version
3609 # `3`. This requirement applies to the following operations:
3610 #
3611 # * Getting a policy that includes a conditional role binding
3612 # * Adding a conditional role binding to a policy
3613 # * Changing a conditional role binding in a policy
3614 # * Removing any role binding, with or without a condition, from a policy
3615 # that includes conditions
3616 #
3617 # **Important:** If you use IAM Conditions, you must include the `etag` field
3618 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3619 # you to overwrite a version `3` policy with a version `1` policy, and all of
3620 # the conditions in the version `3` policy are lost.
3621 #
3622 # If a policy does not include any conditions, operations on that policy may
3623 # specify any valid version or leave the field unset.
3624 #
3625 # To learn which resources support conditions in their IAM policies, see the
3626 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3627 }</pre>
3628 </div>
3629
3630 <div class="method">
3631 <code class="details" id="insert">insert(project, zone, body=None, requestId=None, sourceImage=None, x__xgafv=None)</code>
3632 <pre>Creates a persistent disk in the specified project using the data
3633 in the request. You can create a disk from a source
3634 (sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by
3635 omitting all properties. You can also create a disk that is larger than
3636 the default size by specifying the sizeGb property.
3637
3638 Args:
3639 project: string, Project ID for this request. (required)
3640 zone: string, The name of the zone for this request. (required)
3641 body: object, The request body.
3642 The object takes the form of:
3643
3644 { # Represents a Persistent Disk resource.
3645 #
3646 # Google Compute Engine has two Disk resources:
3647 #
3648 # * [Zonal](/compute/docs/reference/rest/v1/disks)
3649 # * [Regional](/compute/docs/reference/rest/v1/regionDisks)
3650 #
3651 # Persistent disks are required for running your VM instances.
3652 # Create both boot and non-boot (data) persistent disks. For more information,
3653 # read Persistent Disks. For more
3654 # storage options, read Storage options.
3655 #
3656 # The disks resource represents a zonal persistent disk.
3657 # For more information, readZonal persistent disks.
3658 #
3659 # The regionDisks resource represents a
3660 # regional persistent disk. For more information, read
3661 # Regional resources.
3662 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
3663 #
3664 #
3665 # - READ_WRITE_SINGLE: The default AccessMode, means the
3666 # disk can be attached to single instance in RW mode.
3667 # - READ_WRITE_MANY: The AccessMode means the disk can be
3668 # attached to multiple instances in RW mode.
3669 # - READ_ONLY_MANY: The AccessMode means the disk can be
3670 # attached to multiple instances in RO mode.
3671 #
3672 #
3673 # The AccessMode is only valid for Hyperdisk disk types.
3674 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
3675 # ARM64 or X86_64.
3676 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
3677 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
3678 # started on the disk as a member of a group.
3679 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
3680 # started on the disk as a member of a group.
3681 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
3682 # You can provide this as a partial or full URL to the resource.
3683 # For example, the following are valid values:
3684 #
3685 #
3686 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3687 # - projects/project/zones/zone/disks/disk
3688 # - zones/zone/disks/disk
3689 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
3690 # to or from the current disk. This value identifies the exact disk that
3691 # was used to create this replication. For example, if you started
3692 # replicating the persistent disk from a disk that was later deleted and
3693 # recreated under the same name, the disk ID would identify the exact
3694 # version of the disk that was used.
3695 },
3696 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
3697 &quot;a_key&quot;: {
3698 &quot;asyncReplicationDisk&quot;: {
3699 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
3700 # started on the disk as a member of a group.
3701 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
3702 # started on the disk as a member of a group.
3703 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
3704 # You can provide this as a partial or full URL to the resource.
3705 # For example, the following are valid values:
3706 #
3707 #
3708 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3709 # - projects/project/zones/zone/disks/disk
3710 # - zones/zone/disks/disk
3711 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
3712 # to or from the current disk. This value identifies the exact disk that
3713 # was used to create this replication. For example, if you started
3714 # replicating the persistent disk from a disk that was later deleted and
3715 # recreated under the same name, the disk ID would identify the exact
3716 # version of the disk that was used.
3717 },
3718 },
3719 },
3720 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
3721 # text format.
3722 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
3723 # create the resource.
3724 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
3725 # customer-supplied encryption key or a
3726 # customer-managed encryption key.
3727 #
3728 # Encryption keys do not protect access to metadata of the disk.
3729 #
3730 # After you encrypt a disk with a customer-supplied key, you must provide the
3731 # same key if you use the disk later. For example, to create a disk snapshot,
3732 # to create a disk image, to create a machine image, or to attach the disk to
3733 # a virtual machine.
3734 #
3735 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
3736 # name once the disk is created. The disk is encrypted with this version of
3737 # the key. In the response, diskEncryptionKey.kmsKeyName appears
3738 # in the following format:
3739 #
3740 # &quot;diskEncryptionKey.kmsKeyName&quot;:
3741 # &quot;projects/kms_project_id/locations/region/keyRings/
3742 # key_region/cryptoKeys/key
3743 # /cryptoKeysVersions/version
3744 #
3745 # If you do not provide an encryption key when creating the disk, then the
3746 # disk is encrypted using an automatically generated key and you don&#x27;t need
3747 # to provide a key to use the disk later.
3748 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3749 # For example:
3750 #
3751 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3752 # key_region/cryptoKeys/key
3753 #
3754 # The fully-qualifed key name may be returned for resource GET requests. For
3755 # example:
3756 #
3757 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3758 # key_region/cryptoKeys/key
3759 # /cryptoKeyVersions/1
3760 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3761 # key. If absent, the Compute Engine default service account is used.
3762 # For example:
3763 #
3764 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3765 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3766 # encryption key, encoded in RFC
3767 # 4648 base64 to either encrypt or decrypt this resource. You can
3768 # provide either the rawKey or thersaEncryptedKey.
3769 # For example:
3770 #
3771 # &quot;rawKey&quot;:
3772 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
3773 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
3774 # customer-supplied encryption key to either encrypt or decrypt this
3775 # resource. You can provide either the rawKey or thersaEncryptedKey.
3776 # For example:
3777 #
3778 # &quot;rsaEncryptedKey&quot;:
3779 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
3780 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
3781 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
3782 #
3783 # The key must meet the following requirements before you can provide it to
3784 # Compute Engine:
3785 #
3786 # 1. The key is wrapped using a RSA public key certificate provided by
3787 # Google.
3788 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
3789 # encoding.
3790 #
3791 # Gets the RSA public key certificate provided by Google at:
3792 #
3793 #
3794 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
3795 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
3796 # 4648 base64 encoded SHA-256 hash of the customer-supplied
3797 # encryption key that protects this resource.
3798 },
3799 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
3800 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
3801 # only for bootable images. Read
3802 # Enabling guest operating system features to see a list of available
3803 # options.
3804 { # Guest OS features.
3805 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
3806 # separate values. Set to one or more of the following values:
3807 #
3808 # - VIRTIO_SCSI_MULTIQUEUE
3809 # - WINDOWS
3810 # - MULTI_IP_SUBNET
3811 # - UEFI_COMPATIBLE
3812 # - GVNIC
3813 # - SEV_CAPABLE
3814 # - SUSPEND_RESUME_COMPATIBLE
3815 # - SEV_LIVE_MIGRATABLE_V2
3816 # - SEV_SNP_CAPABLE
3817 # - TDX_CAPABLE
3818 # - IDPF
3819 # - SNP_SVSM_CAPABLE
3820 # - CCA_CAPABLE
3821 #
3822 #
3823 # For more information, see
3824 # Enabling guest operating system features.
3825 },
3826 ],
3827 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
3828 # defined by the server.
3829 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
3830 # disks.
3831 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
3832 # essentially a hash of the labels set used for optimistic locking. The
3833 # fingerprint is initially generated by Compute Engine and changes after
3834 # every request to modify or update labels. You must always provide an
3835 # up-to-date fingerprint hash in order to update or change labels,
3836 # otherwise the request will fail with error412 conditionNotMet.
3837 #
3838 # To see the latest fingerprint, make a get() request to
3839 # retrieve a disk.
3840 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
3841 # the setLabels method.
3842 &quot;a_key&quot;: &quot;A String&quot;,
3843 },
3844 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
3845 # text format.
3846 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
3847 # text format.
3848 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
3849 &quot;A String&quot;,
3850 ],
3851 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
3852 &quot;A String&quot;,
3853 ],
3854 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
3855 # This field is for use by internal tools that use the public API.
3856 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
3857 # The name must be 1-63 characters long, and comply withRFC1035.
3858 # Specifically, the name must be 1-63 characters long and match the regular
3859 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
3860 # which means the first character must be a lowercase letter, and all
3861 # following characters must be a dash, lowercase letter, or digit, except
3862 # the last character, which cannot be a dash.
3863 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
3864 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
3865 # as part of resource payload.
3866 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
3867 # have the same definition as resource
3868 # manager tags. Keys and values can be either in numeric format,
3869 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
3870 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
3871 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
3872 # PATCH) when empty.
3873 &quot;a_key&quot;: &quot;A String&quot;,
3874 },
3875 },
3876 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
3877 # If not present in a request, a default value is used.
3878 # The currently supported size is 4096, other sizes may be added in
3879 # the future.
3880 # If an unsupported value is requested, the error message will list
3881 # the supported values for the caller&#x27;s project.
3882 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
3883 # of I/O operations per second that the disk can handle. Values must be
3884 # between 10,000 and 120,000. For more details, see theExtreme persistent
3885 # disk documentation.
3886 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
3887 # number of throughput mb per second that the disk can handle. Values must be
3888 # greater than or equal to 1.
3889 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
3890 # regional resources.
3891 # You must specify this field as part of the HTTP request URL. It is
3892 # not settable as a field in the request body.
3893 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
3894 # for regional resources.
3895 &quot;A String&quot;,
3896 ],
3897 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
3898 &quot;A String&quot;,
3899 ],
3900 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
3901 &quot;asyncPrimaryDisk&quot;: {
3902 &quot;state&quot;: &quot;A String&quot;,
3903 },
3904 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
3905 &quot;a_key&quot;: {
3906 &quot;state&quot;: &quot;A String&quot;,
3907 },
3908 },
3909 },
3910 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
3911 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
3912 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
3913 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
3914 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
3915 # persistent disk.
3916 #
3917 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
3918 # source.
3919 # Acceptable values are greater than 0.
3920 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
3921 # that was created using a consistency group.
3922 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
3923 # that was created using a consistency group.
3924 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
3925 # partial or full URL to the resource. For example, the following are valid
3926 # values:
3927 #
3928 #
3929 # -
3930 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
3931 #
3932 # -
3933 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
3934 #
3935 # -
3936 # projects/project/zones/zone/disks/disk
3937 #
3938 # -
3939 # projects/project/regions/region/disks/disk
3940 #
3941 # -
3942 # zones/zone/disks/disk
3943 #
3944 # -
3945 # regions/region/disks/disk
3946 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
3947 # value identifies the exact disk that was used to create this persistent
3948 # disk. For example, if you created the persistent disk from a disk that
3949 # was later deleted and recreated under the same name, the source disk ID
3950 # would identify the exact version of the disk that was used.
3951 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
3952 # deleted, this field will not be set.
3953 #
3954 # To create a disk with one of the public operating system images, specify
3955 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
3956 #
3957 # projects/debian-cloud/global/images/family/debian-9
3958 #
3959 #
3960 # Alternatively, use a specific version of a public operating system image:
3961 #
3962 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
3963 #
3964 #
3965 # To create a disk with a custom image that you created, specify the
3966 # image name in the following format:
3967 #
3968 # global/images/my-custom-image
3969 #
3970 #
3971 # You can also specify a custom image by its image family, which returns
3972 # the latest version of the image in that family. Replace the image name
3973 # with family/family-name:
3974 #
3975 # global/images/family/my-image-family
3976 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
3977 # encryption key of the source image. Required if the source image is
3978 # protected by a customer-supplied encryption key.
3979 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
3980 # For example:
3981 #
3982 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3983 # key_region/cryptoKeys/key
3984 #
3985 # The fully-qualifed key name may be returned for resource GET requests. For
3986 # example:
3987 #
3988 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
3989 # key_region/cryptoKeys/key
3990 # /cryptoKeyVersions/1
3991 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
3992 # key. If absent, the Compute Engine default service account is used.
3993 # For example:
3994 #
3995 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
3996 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
3997 # encryption key, encoded in RFC
3998 # 4648 base64 to either encrypt or decrypt this resource. You can
3999 # provide either the rawKey or thersaEncryptedKey.
4000 # For example:
4001 #
4002 # &quot;rawKey&quot;:
4003 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4004 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4005 # customer-supplied encryption key to either encrypt or decrypt this
4006 # resource. You can provide either the rawKey or thersaEncryptedKey.
4007 # For example:
4008 #
4009 # &quot;rsaEncryptedKey&quot;:
4010 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4011 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4012 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4013 #
4014 # The key must meet the following requirements before you can provide it to
4015 # Compute Engine:
4016 #
4017 # 1. The key is wrapped using a RSA public key certificate provided by
4018 # Google.
4019 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4020 # encoding.
4021 #
4022 # Gets the RSA public key certificate provided by Google at:
4023 #
4024 #
4025 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4026 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4027 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4028 # encryption key that protects this resource.
4029 },
4030 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
4031 # value identifies the exact image that was used to create this persistent
4032 # disk. For example, if you created the persistent disk from an image that
4033 # was later deleted and recreated under the same name, the source image ID
4034 # would identify the exact version of the image that was used.
4035 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
4036 # this as a partial or full URL to the resource. For example, the following
4037 # are valid values:
4038 #
4039 #
4040 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
4041 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
4042 # - zones/zone/instantSnapshots/instantSnapshot
4043 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
4044 # disk. This value identifies the exact instant snapshot that was used to
4045 # create this persistent disk. For example, if you created the persistent
4046 # disk from an instant snapshot that was later deleted and recreated under
4047 # the same name, the source instant snapshot ID would identify the exact
4048 # version of the instant snapshot that was used.
4049 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
4050 # partial or full URL to the resource. For example, the following are valid
4051 # values:
4052 #
4053 #
4054 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
4055 # - projects/project/global/snapshots/snapshot
4056 # - global/snapshots/snapshot
4057 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4058 # encryption key of the source snapshot. Required if the source snapshot
4059 # is protected by a customer-supplied encryption key.
4060 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4061 # For example:
4062 #
4063 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4064 # key_region/cryptoKeys/key
4065 #
4066 # The fully-qualifed key name may be returned for resource GET requests. For
4067 # example:
4068 #
4069 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4070 # key_region/cryptoKeys/key
4071 # /cryptoKeyVersions/1
4072 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4073 # key. If absent, the Compute Engine default service account is used.
4074 # For example:
4075 #
4076 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4077 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4078 # encryption key, encoded in RFC
4079 # 4648 base64 to either encrypt or decrypt this resource. You can
4080 # provide either the rawKey or thersaEncryptedKey.
4081 # For example:
4082 #
4083 # &quot;rawKey&quot;:
4084 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4085 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4086 # customer-supplied encryption key to either encrypt or decrypt this
4087 # resource. You can provide either the rawKey or thersaEncryptedKey.
4088 # For example:
4089 #
4090 # &quot;rsaEncryptedKey&quot;:
4091 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4092 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4093 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4094 #
4095 # The key must meet the following requirements before you can provide it to
4096 # Compute Engine:
4097 #
4098 # 1. The key is wrapped using a RSA public key certificate provided by
4099 # Google.
4100 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4101 # encoding.
4102 #
4103 # Gets the RSA public key certificate provided by Google at:
4104 #
4105 #
4106 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4107 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4108 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4109 # encryption key that protects this resource.
4110 },
4111 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
4112 # value identifies the exact snapshot that was used to create this persistent
4113 # disk. For example, if you created the persistent disk from a snapshot that
4114 # was later deleted and recreated under the same name, the source snapshot ID
4115 # would identify the exact version of the snapshot that was used.
4116 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
4117 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
4118 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
4119 # https://storage.googleapis.com/. This flag is not optimized for creating
4120 # multiple disks from a source storage object. To create many disks from a
4121 # source storage object, use gcloud compute images
4122 # import instead.
4123 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
4124 #
4125 #
4126 # - CREATING: Disk is provisioning.
4127 # - RESTORING: Source data is being copied into the
4128 # disk.
4129 # - FAILED: Disk creation failed.
4130 # - READY: Disk is ready for use.
4131 # - DELETING: Disk is deleting.
4132 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
4133 # this as a partial or full URL to the resource. For example, the following
4134 # are valid values:
4135 #
4136 #
4137 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
4138 # - projects/project/zones/zone/storagePools/storagePool
4139 # - zones/zone/storagePools/storagePool
4140 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
4141 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
4142 # types.
4143 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
4144 # in form:projects/project/zones/zone/instances/instance
4145 &quot;A String&quot;,
4146 ],
4147 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
4148 # You must specify this field as part of the HTTP request URL. It is
4149 # not settable as a field in the request body.
4150 }
4151
4152 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4153 that if you must retry your request, the server will know to ignore the
4154 request if it has already been completed.
4155
4156 For example, consider a situation where you make an initial request and
4157 the request times out. If you make the request again with the same
4158 request ID, the server can check if original operation with the same
4159 request ID was received, and if so, will ignore the second request. This
4160 prevents clients from accidentally creating duplicate commitments.
4161
4162 The request ID must be
4163 a valid UUID with the exception that zero UUID is not supported
4164 (00000000-0000-0000-0000-000000000000).
4165 sourceImage: string, Source image to restore onto a disk. This field is optional.
4166 x__xgafv: string, V1 error format.
4167 Allowed values
4168 1 - v1 error format
4169 2 - v2 error format
4170
4171 Returns:
4172 An object of the form:
4173
4174 { # Represents an Operation resource.
4175 #
4176 # Google Compute Engine has three Operation resources:
4177 #
4178 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
4179 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
4180 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
4181 #
4182 # You can use an operation resource to manage asynchronous API requests.
4183 # For more information, readHandling
4184 # API responses.
4185 #
4186 # Operations can be global, regional or zonal.
4187 #
4188 # - For global operations, use the `globalOperations`
4189 # resource.
4190 # - For regional operations, use the
4191 # `regionOperations` resource.
4192 # - For zonal operations, use
4193 # the `zoneOperations` resource.
4194 #
4195 #
4196 #
4197 # For more information, read
4198 # Global, Regional, and Zonal Resources.
4199 #
4200 # Note that completed Operation resources have a limited
4201 # retention period.
4202 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4203 # Not present otherwise.
4204 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4205 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4206 # set when the operation is created.
4207 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4208 # text format.
4209 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4210 # this field will be populated.
4211 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4212 # operation.
4213 {
4214 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4215 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4216 # details. There is a set of defined message types to use for providing
4217 # details.The syntax depends on the error code. For example,
4218 # QuotaExceededInfo will have details when the error code is
4219 # QUOTA_EXCEEDED.
4220 {
4221 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4222 #
4223 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4224 # is not enabled:
4225 #
4226 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4227 # &quot;domain&quot;: &quot;googleapis.com&quot;
4228 # &quot;metadata&quot;: {
4229 # &quot;resource&quot;: &quot;projects/123&quot;,
4230 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4231 # }
4232 # }
4233 #
4234 # This response indicates that the pubsub.googleapis.com API is not enabled.
4235 #
4236 # Example of an error that is returned when attempting to create a Spanner
4237 # instance in a region that is out of stock:
4238 #
4239 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4240 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4241 # &quot;metadata&quot;: {
4242 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4243 # }
4244 # }
4245 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4246 # is typically the registered service name of the tool or product that
4247 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4248 # generated by some common infrastructure, the error domain must be a
4249 # globally unique value that identifies the infrastructure. For Google API
4250 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4251 &quot;metadatas&quot;: { # Additional structured details about this error.
4252 #
4253 # Keys must match a regular expression of `a-z+` but should
4254 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4255 # length. When identifying the current value of an exceeded limit, the units
4256 # should be contained in the key, not the value. For example, rather than
4257 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4258 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4259 # instances that can be created in a single (batch) request.
4260 &quot;a_key&quot;: &quot;A String&quot;,
4261 },
4262 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4263 # proximate cause of the error. Error reasons are unique within a particular
4264 # domain of errors. This should be at most 63 characters and match a
4265 # regular expression of `A-Z+[A-Z0-9]`, which represents
4266 # UPPER_SNAKE_CASE.
4267 },
4268 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4269 #
4270 # For example, if a quota check failed with an error indicating the calling
4271 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4272 # directly to the right place in the developer console to flip the bit.
4273 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4274 { # Describes a URL link.
4275 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4276 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4277 },
4278 ],
4279 },
4280 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4281 # which can be attached to an RPC error.
4282 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4283 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4284 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4285 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4286 },
4287 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4288 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4289 &quot;a_key&quot;: &quot;A String&quot;,
4290 },
4291 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4292 # type or metric.
4293 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4294 # or metric.
4295 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4296 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4297 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4298 },
4299 },
4300 ],
4301 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4302 # This property is optional.
4303 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4304 },
4305 ],
4306 },
4307 &quot;getVersionOperationMetadata&quot;: {
4308 &quot;inlineSbomInfo&quot;: {
4309 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4310 # appropriate identifiers.
4311 &quot;a_key&quot;: &quot;A String&quot;,
4312 },
4313 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4314 # identifiers.
4315 &quot;a_key&quot;: &quot;A String&quot;,
4316 },
4317 },
4318 },
4319 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4320 # message that was returned, such as `NOT FOUND`.
4321 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4322 # status code that was returned. For example, a `404` means the
4323 # resource was not found.
4324 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4325 # defined by the server.
4326 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4327 # This value is inRFC3339
4328 # text format.
4329 &quot;instancesBulkInsertOperationMetadata&quot;: {
4330 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4331 # Example key: zones/us-central1-a
4332 &quot;a_key&quot;: {
4333 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4334 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4335 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4336 # error.
4337 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4338 # if the flow is rolling forward or rolling back.
4339 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4340 },
4341 },
4342 },
4343 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4344 # Operation resources.
4345 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4346 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4347 # group of operations results from a `bulkInsert` API request.
4348 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4349 # `update`, or `delete`, and so on.
4350 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4351 # There is no requirement that this be linear or support any granularity of
4352 # operations. This should not be used to guess when the operation will be
4353 # complete. This number should monotonically increase as the operation
4354 # progresses.
4355 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4356 # applicable when performing regional operations.
4357 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4358 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4359 # this field will contain information on all underlying zonal actions and
4360 # their state.
4361 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4362 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4363 # Example key: zones/us-central1-a
4364 &quot;a_key&quot;: {
4365 &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
4366 # populated.
4367 # different programming environments, including REST APIs and RPC APIs. It is
4368 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4369 # three pieces of data: error code, error message, and error details.
4370 #
4371 # You can find out more about this error model and how to work with it in the
4372 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4373 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4374 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4375 # message types for APIs to use.
4376 {
4377 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4378 },
4379 ],
4380 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4381 # user-facing error message should be localized and sent in the
4382 # google.rpc.Status.details field, or localized by the client.
4383 },
4384 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4385 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4386 },
4387 },
4388 },
4389 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4390 # This value is inRFC3339
4391 # text format.
4392 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4393 # following:
4394 # `PENDING`, `RUNNING`, or `DONE`.
4395 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4396 # operation.
4397 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4398 # of the target resource.
4399 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4400 # operations related to creating a snapshot, this points to the disk
4401 # that the snapshot was created from.
4402 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4403 # `[email protected]` or
4404 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4405 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4406 # operation, this field will be populated.
4407 {
4408 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4409 # Engine returns NO_RESULTS_ON_PAGE if there
4410 # are no results in the response.
4411 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4412 # value format. For example:
4413 #
4414 # &quot;data&quot;: [
4415 # {
4416 # &quot;key&quot;: &quot;scope&quot;,
4417 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4418 # }
4419 {
4420 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4421 # returned. For example, for warnings where there are no results in a list
4422 # request for a particular zone, this key might be scope and
4423 # the key value might be the zone name. Other examples might be a key
4424 # indicating a deprecated resource and a suggested replacement, or a
4425 # warning about invalid network settings (for example, if an instance
4426 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4427 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4428 },
4429 ],
4430 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4431 },
4432 ],
4433 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4434 # applicable when performing per-zone operations.
4435 }</pre>
4436 </div>
4437
4438 <div class="method">
4439 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
4440 <pre>Retrieves a list of persistent disks contained within
4441 the specified zone.
4442
4443 Args:
4444 project: string, Project ID for this request. (required)
4445 zone: string, The name of the zone for this request. (required)
4446 filter: string, A filter expression that filters resources listed in the response. Most
4447 Compute resources support two types of filter expressions:
4448 expressions that support regular expressions and expressions that follow
4449 API improvement proposal AIP-160.
4450 These two types of filter expressions cannot be mixed in one request.
4451
4452 If you want to use AIP-160, your expression must specify the field name, an
4453 operator, and the value that you want to use for filtering. The value
4454 must be a string, a number, or a boolean. The operator
4455 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
4456
4457 For example, if you are filtering Compute Engine instances, you can
4458 exclude instances named `example-instance` by specifying
4459 `name != example-instance`.
4460
4461 The `:*` comparison can be used to test whether a key has been defined.
4462 For example, to find all objects with `owner` label use:
4463 ```
4464 labels.owner:*
4465 ```
4466
4467 You can also filter nested fields. For example, you could specify
4468 `scheduling.automaticRestart = false` to include instances only
4469 if they are not scheduled for automatic restarts. You can use filtering
4470 on nested fields to filter based onresource labels.
4471
4472 To filter on multiple expressions, provide each separate expression within
4473 parentheses. For example:
4474 ```
4475 (scheduling.automaticRestart = true)
4476 (cpuPlatform = &quot;Intel Skylake&quot;)
4477 ```
4478 By default, each expression is an `AND` expression. However, you
4479 can include `AND` and `OR` expressions explicitly.
4480 For example:
4481 ```
4482 (cpuPlatform = &quot;Intel Skylake&quot;) OR
4483 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
4484 (scheduling.automaticRestart = true)
4485 ```
4486
4487 If you want to use a regular expression, use the `eq` (equal) or `ne`
4488 (not equal) operator against a single un-parenthesized expression with or
4489 without quotes or against multiple parenthesized expressions. Examples:
4490
4491 `fieldname eq unquoted literal`
4492 `fieldname eq &#x27;single quoted literal&#x27;`
4493 `fieldname eq &quot;double quoted literal&quot;`
4494 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
4495
4496 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
4497 The literal value must match the entire field.
4498
4499 For example, to filter for instances that do not end with name &quot;instance&quot;,
4500 you would use `name ne .*instance`.
4501
4502 You cannot combine constraints on multiple fields using regular
4503 expressions.
4504 maxResults: integer, The maximum number of results per page that should be returned.
4505 If the number of available results is larger than `maxResults`,
4506 Compute Engine returns a `nextPageToken` that can be used to get
4507 the next page of results in subsequent list requests. Acceptable values are
4508 `0` to `500`, inclusive. (Default: `500`)
4509 orderBy: string, Sorts list results by a certain order. By default, results
4510 are returned in alphanumerical order based on the resource name.
4511
4512 You can also sort results in descending order based on the creation
4513 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
4514 results based on the `creationTimestamp` field in
4515 reverse chronological order (newest result first). Use this to sort
4516 resources like operations so that the newest operation is returned first.
4517
4518 Currently, only sorting by `name` or
4519 `creationTimestamp desc` is supported.
4520 pageToken: string, Specifies a page token to use. Set `pageToken` to the
4521 `nextPageToken` returned by a previous list request to get
4522 the next page of results.
4523 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
4524 of failure. The default value is false.
4525
4526 For example, when partial success behavior is enabled, aggregatedList for a
4527 single zone scope either returns all resources in the zone or no resources,
4528 with an error code.
4529 x__xgafv: string, V1 error format.
4530 Allowed values
4531 1 - v1 error format
4532 2 - v2 error format
4533
4534 Returns:
4535 An object of the form:
4536
4537 { # A list of Disk resources.
4538 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
4539 &quot;items&quot;: [ # A list of Disk resources.
4540 { # Represents a Persistent Disk resource.
4541 #
4542 # Google Compute Engine has two Disk resources:
4543 #
4544 # * [Zonal](/compute/docs/reference/rest/v1/disks)
4545 # * [Regional](/compute/docs/reference/rest/v1/regionDisks)
4546 #
4547 # Persistent disks are required for running your VM instances.
4548 # Create both boot and non-boot (data) persistent disks. For more information,
4549 # read Persistent Disks. For more
4550 # storage options, read Storage options.
4551 #
4552 # The disks resource represents a zonal persistent disk.
4553 # For more information, readZonal persistent disks.
4554 #
4555 # The regionDisks resource represents a
4556 # regional persistent disk. For more information, read
4557 # Regional resources.
4558 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
4559 #
4560 #
4561 # - READ_WRITE_SINGLE: The default AccessMode, means the
4562 # disk can be attached to single instance in RW mode.
4563 # - READ_WRITE_MANY: The AccessMode means the disk can be
4564 # attached to multiple instances in RW mode.
4565 # - READ_ONLY_MANY: The AccessMode means the disk can be
4566 # attached to multiple instances in RO mode.
4567 #
4568 #
4569 # The AccessMode is only valid for Hyperdisk disk types.
4570 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
4571 # ARM64 or X86_64.
4572 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
4573 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
4574 # started on the disk as a member of a group.
4575 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
4576 # started on the disk as a member of a group.
4577 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
4578 # You can provide this as a partial or full URL to the resource.
4579 # For example, the following are valid values:
4580 #
4581 #
4582 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4583 # - projects/project/zones/zone/disks/disk
4584 # - zones/zone/disks/disk
4585 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
4586 # to or from the current disk. This value identifies the exact disk that
4587 # was used to create this replication. For example, if you started
4588 # replicating the persistent disk from a disk that was later deleted and
4589 # recreated under the same name, the disk ID would identify the exact
4590 # version of the disk that was used.
4591 },
4592 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
4593 &quot;a_key&quot;: {
4594 &quot;asyncReplicationDisk&quot;: {
4595 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
4596 # started on the disk as a member of a group.
4597 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
4598 # started on the disk as a member of a group.
4599 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
4600 # You can provide this as a partial or full URL to the resource.
4601 # For example, the following are valid values:
4602 #
4603 #
4604 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4605 # - projects/project/zones/zone/disks/disk
4606 # - zones/zone/disks/disk
4607 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
4608 # to or from the current disk. This value identifies the exact disk that
4609 # was used to create this replication. For example, if you started
4610 # replicating the persistent disk from a disk that was later deleted and
4611 # recreated under the same name, the disk ID would identify the exact
4612 # version of the disk that was used.
4613 },
4614 },
4615 },
4616 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
4617 # text format.
4618 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
4619 # create the resource.
4620 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
4621 # customer-supplied encryption key or a
4622 # customer-managed encryption key.
4623 #
4624 # Encryption keys do not protect access to metadata of the disk.
4625 #
4626 # After you encrypt a disk with a customer-supplied key, you must provide the
4627 # same key if you use the disk later. For example, to create a disk snapshot,
4628 # to create a disk image, to create a machine image, or to attach the disk to
4629 # a virtual machine.
4630 #
4631 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
4632 # name once the disk is created. The disk is encrypted with this version of
4633 # the key. In the response, diskEncryptionKey.kmsKeyName appears
4634 # in the following format:
4635 #
4636 # &quot;diskEncryptionKey.kmsKeyName&quot;:
4637 # &quot;projects/kms_project_id/locations/region/keyRings/
4638 # key_region/cryptoKeys/key
4639 # /cryptoKeysVersions/version
4640 #
4641 # If you do not provide an encryption key when creating the disk, then the
4642 # disk is encrypted using an automatically generated key and you don&#x27;t need
4643 # to provide a key to use the disk later.
4644 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4645 # For example:
4646 #
4647 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4648 # key_region/cryptoKeys/key
4649 #
4650 # The fully-qualifed key name may be returned for resource GET requests. For
4651 # example:
4652 #
4653 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4654 # key_region/cryptoKeys/key
4655 # /cryptoKeyVersions/1
4656 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4657 # key. If absent, the Compute Engine default service account is used.
4658 # For example:
4659 #
4660 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4661 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4662 # encryption key, encoded in RFC
4663 # 4648 base64 to either encrypt or decrypt this resource. You can
4664 # provide either the rawKey or thersaEncryptedKey.
4665 # For example:
4666 #
4667 # &quot;rawKey&quot;:
4668 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4669 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4670 # customer-supplied encryption key to either encrypt or decrypt this
4671 # resource. You can provide either the rawKey or thersaEncryptedKey.
4672 # For example:
4673 #
4674 # &quot;rsaEncryptedKey&quot;:
4675 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4676 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4677 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4678 #
4679 # The key must meet the following requirements before you can provide it to
4680 # Compute Engine:
4681 #
4682 # 1. The key is wrapped using a RSA public key certificate provided by
4683 # Google.
4684 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4685 # encoding.
4686 #
4687 # Gets the RSA public key certificate provided by Google at:
4688 #
4689 #
4690 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4691 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4692 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4693 # encryption key that protects this resource.
4694 },
4695 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
4696 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
4697 # only for bootable images. Read
4698 # Enabling guest operating system features to see a list of available
4699 # options.
4700 { # Guest OS features.
4701 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
4702 # separate values. Set to one or more of the following values:
4703 #
4704 # - VIRTIO_SCSI_MULTIQUEUE
4705 # - WINDOWS
4706 # - MULTI_IP_SUBNET
4707 # - UEFI_COMPATIBLE
4708 # - GVNIC
4709 # - SEV_CAPABLE
4710 # - SUSPEND_RESUME_COMPATIBLE
4711 # - SEV_LIVE_MIGRATABLE_V2
4712 # - SEV_SNP_CAPABLE
4713 # - TDX_CAPABLE
4714 # - IDPF
4715 # - SNP_SVSM_CAPABLE
4716 # - CCA_CAPABLE
4717 #
4718 #
4719 # For more information, see
4720 # Enabling guest operating system features.
4721 },
4722 ],
4723 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
4724 # defined by the server.
4725 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
4726 # disks.
4727 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
4728 # essentially a hash of the labels set used for optimistic locking. The
4729 # fingerprint is initially generated by Compute Engine and changes after
4730 # every request to modify or update labels. You must always provide an
4731 # up-to-date fingerprint hash in order to update or change labels,
4732 # otherwise the request will fail with error412 conditionNotMet.
4733 #
4734 # To see the latest fingerprint, make a get() request to
4735 # retrieve a disk.
4736 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
4737 # the setLabels method.
4738 &quot;a_key&quot;: &quot;A String&quot;,
4739 },
4740 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
4741 # text format.
4742 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
4743 # text format.
4744 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
4745 &quot;A String&quot;,
4746 ],
4747 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
4748 &quot;A String&quot;,
4749 ],
4750 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
4751 # This field is for use by internal tools that use the public API.
4752 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
4753 # The name must be 1-63 characters long, and comply withRFC1035.
4754 # Specifically, the name must be 1-63 characters long and match the regular
4755 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
4756 # which means the first character must be a lowercase letter, and all
4757 # following characters must be a dash, lowercase letter, or digit, except
4758 # the last character, which cannot be a dash.
4759 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
4760 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
4761 # as part of resource payload.
4762 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
4763 # have the same definition as resource
4764 # manager tags. Keys and values can be either in numeric format,
4765 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
4766 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
4767 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
4768 # PATCH) when empty.
4769 &quot;a_key&quot;: &quot;A String&quot;,
4770 },
4771 },
4772 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
4773 # If not present in a request, a default value is used.
4774 # The currently supported size is 4096, other sizes may be added in
4775 # the future.
4776 # If an unsupported value is requested, the error message will list
4777 # the supported values for the caller&#x27;s project.
4778 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
4779 # of I/O operations per second that the disk can handle. Values must be
4780 # between 10,000 and 120,000. For more details, see theExtreme persistent
4781 # disk documentation.
4782 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
4783 # number of throughput mb per second that the disk can handle. Values must be
4784 # greater than or equal to 1.
4785 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
4786 # regional resources.
4787 # You must specify this field as part of the HTTP request URL. It is
4788 # not settable as a field in the request body.
4789 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
4790 # for regional resources.
4791 &quot;A String&quot;,
4792 ],
4793 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
4794 &quot;A String&quot;,
4795 ],
4796 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
4797 &quot;asyncPrimaryDisk&quot;: {
4798 &quot;state&quot;: &quot;A String&quot;,
4799 },
4800 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
4801 &quot;a_key&quot;: {
4802 &quot;state&quot;: &quot;A String&quot;,
4803 },
4804 },
4805 },
4806 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
4807 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
4808 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
4809 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
4810 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
4811 # persistent disk.
4812 #
4813 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
4814 # source.
4815 # Acceptable values are greater than 0.
4816 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
4817 # that was created using a consistency group.
4818 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
4819 # that was created using a consistency group.
4820 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
4821 # partial or full URL to the resource. For example, the following are valid
4822 # values:
4823 #
4824 #
4825 # -
4826 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
4827 #
4828 # -
4829 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
4830 #
4831 # -
4832 # projects/project/zones/zone/disks/disk
4833 #
4834 # -
4835 # projects/project/regions/region/disks/disk
4836 #
4837 # -
4838 # zones/zone/disks/disk
4839 #
4840 # -
4841 # regions/region/disks/disk
4842 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
4843 # value identifies the exact disk that was used to create this persistent
4844 # disk. For example, if you created the persistent disk from a disk that
4845 # was later deleted and recreated under the same name, the source disk ID
4846 # would identify the exact version of the disk that was used.
4847 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
4848 # deleted, this field will not be set.
4849 #
4850 # To create a disk with one of the public operating system images, specify
4851 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
4852 #
4853 # projects/debian-cloud/global/images/family/debian-9
4854 #
4855 #
4856 # Alternatively, use a specific version of a public operating system image:
4857 #
4858 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
4859 #
4860 #
4861 # To create a disk with a custom image that you created, specify the
4862 # image name in the following format:
4863 #
4864 # global/images/my-custom-image
4865 #
4866 #
4867 # You can also specify a custom image by its image family, which returns
4868 # the latest version of the image in that family. Replace the image name
4869 # with family/family-name:
4870 #
4871 # global/images/family/my-image-family
4872 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
4873 # encryption key of the source image. Required if the source image is
4874 # protected by a customer-supplied encryption key.
4875 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4876 # For example:
4877 #
4878 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4879 # key_region/cryptoKeys/key
4880 #
4881 # The fully-qualifed key name may be returned for resource GET requests. For
4882 # example:
4883 #
4884 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4885 # key_region/cryptoKeys/key
4886 # /cryptoKeyVersions/1
4887 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4888 # key. If absent, the Compute Engine default service account is used.
4889 # For example:
4890 #
4891 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4892 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4893 # encryption key, encoded in RFC
4894 # 4648 base64 to either encrypt or decrypt this resource. You can
4895 # provide either the rawKey or thersaEncryptedKey.
4896 # For example:
4897 #
4898 # &quot;rawKey&quot;:
4899 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4900 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4901 # customer-supplied encryption key to either encrypt or decrypt this
4902 # resource. You can provide either the rawKey or thersaEncryptedKey.
4903 # For example:
4904 #
4905 # &quot;rsaEncryptedKey&quot;:
4906 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4907 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4908 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4909 #
4910 # The key must meet the following requirements before you can provide it to
4911 # Compute Engine:
4912 #
4913 # 1. The key is wrapped using a RSA public key certificate provided by
4914 # Google.
4915 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4916 # encoding.
4917 #
4918 # Gets the RSA public key certificate provided by Google at:
4919 #
4920 #
4921 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
4922 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
4923 # 4648 base64 encoded SHA-256 hash of the customer-supplied
4924 # encryption key that protects this resource.
4925 },
4926 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
4927 # value identifies the exact image that was used to create this persistent
4928 # disk. For example, if you created the persistent disk from an image that
4929 # was later deleted and recreated under the same name, the source image ID
4930 # would identify the exact version of the image that was used.
4931 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
4932 # this as a partial or full URL to the resource. For example, the following
4933 # are valid values:
4934 #
4935 #
4936 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
4937 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
4938 # - zones/zone/instantSnapshots/instantSnapshot
4939 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
4940 # disk. This value identifies the exact instant snapshot that was used to
4941 # create this persistent disk. For example, if you created the persistent
4942 # disk from an instant snapshot that was later deleted and recreated under
4943 # the same name, the source instant snapshot ID would identify the exact
4944 # version of the instant snapshot that was used.
4945 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
4946 # partial or full URL to the resource. For example, the following are valid
4947 # values:
4948 #
4949 #
4950 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
4951 # - projects/project/global/snapshots/snapshot
4952 # - global/snapshots/snapshot
4953 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
4954 # encryption key of the source snapshot. Required if the source snapshot
4955 # is protected by a customer-supplied encryption key.
4956 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
4957 # For example:
4958 #
4959 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4960 # key_region/cryptoKeys/key
4961 #
4962 # The fully-qualifed key name may be returned for resource GET requests. For
4963 # example:
4964 #
4965 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
4966 # key_region/cryptoKeys/key
4967 # /cryptoKeyVersions/1
4968 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
4969 # key. If absent, the Compute Engine default service account is used.
4970 # For example:
4971 #
4972 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
4973 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
4974 # encryption key, encoded in RFC
4975 # 4648 base64 to either encrypt or decrypt this resource. You can
4976 # provide either the rawKey or thersaEncryptedKey.
4977 # For example:
4978 #
4979 # &quot;rawKey&quot;:
4980 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
4981 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
4982 # customer-supplied encryption key to either encrypt or decrypt this
4983 # resource. You can provide either the rawKey or thersaEncryptedKey.
4984 # For example:
4985 #
4986 # &quot;rsaEncryptedKey&quot;:
4987 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
4988 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
4989 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
4990 #
4991 # The key must meet the following requirements before you can provide it to
4992 # Compute Engine:
4993 #
4994 # 1. The key is wrapped using a RSA public key certificate provided by
4995 # Google.
4996 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
4997 # encoding.
4998 #
4999 # Gets the RSA public key certificate provided by Google at:
5000 #
5001 #
5002 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
5003 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
5004 # 4648 base64 encoded SHA-256 hash of the customer-supplied
5005 # encryption key that protects this resource.
5006 },
5007 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
5008 # value identifies the exact snapshot that was used to create this persistent
5009 # disk. For example, if you created the persistent disk from a snapshot that
5010 # was later deleted and recreated under the same name, the source snapshot ID
5011 # would identify the exact version of the snapshot that was used.
5012 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
5013 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
5014 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
5015 # https://storage.googleapis.com/. This flag is not optimized for creating
5016 # multiple disks from a source storage object. To create many disks from a
5017 # source storage object, use gcloud compute images
5018 # import instead.
5019 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
5020 #
5021 #
5022 # - CREATING: Disk is provisioning.
5023 # - RESTORING: Source data is being copied into the
5024 # disk.
5025 # - FAILED: Disk creation failed.
5026 # - READY: Disk is ready for use.
5027 # - DELETING: Disk is deleting.
5028 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
5029 # this as a partial or full URL to the resource. For example, the following
5030 # are valid values:
5031 #
5032 #
5033 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
5034 # - projects/project/zones/zone/storagePools/storagePool
5035 # - zones/zone/storagePools/storagePool
5036 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
5037 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
5038 # types.
5039 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
5040 # in form:projects/project/zones/zone/instances/instance
5041 &quot;A String&quot;,
5042 ],
5043 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
5044 # You must specify this field as part of the HTTP request URL. It is
5045 # not settable as a field in the request body.
5046 },
5047 ],
5048 &quot;kind&quot;: &quot;compute#diskList&quot;, # Output only. [Output Only] Type of resource. Always compute#diskList for
5049 # lists of disks.
5050 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
5051 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
5052 # the query parameter pageToken in the next list request.
5053 # Subsequent list requests will have their own nextPageToken to
5054 # continue paging through the results.
5055 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
5056 &quot;warning&quot;: { # [Output Only] Informational warning message.
5057 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5058 # Engine returns NO_RESULTS_ON_PAGE if there
5059 # are no results in the response.
5060 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5061 # value format. For example:
5062 #
5063 # &quot;data&quot;: [
5064 # {
5065 # &quot;key&quot;: &quot;scope&quot;,
5066 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5067 # }
5068 {
5069 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5070 # returned. For example, for warnings where there are no results in a list
5071 # request for a particular zone, this key might be scope and
5072 # the key value might be the zone name. Other examples might be a key
5073 # indicating a deprecated resource and a suggested replacement, or a
5074 # warning about invalid network settings (for example, if an instance
5075 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5076 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5077 },
5078 ],
5079 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5080 },
5081 }</pre>
5082 </div>
5083
5084 <div class="method">
5085 <code class="details" id="list_next">list_next()</code>
5086 <pre>Retrieves the next page of results.
5087
5088 Args:
5089 previous_request: The request for the previous page. (required)
5090 previous_response: The response from the request for the previous page. (required)
5091
5092 Returns:
5093 A request object that you can call &#x27;execute()&#x27; on to request the next
5094 page. Returns None if there are no more items in the collection.
5095 </pre>
5096 </div>
5097
5098 <div class="method">
5099 <code class="details" id="removeResourcePolicies">removeResourcePolicies(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
5100 <pre>Removes resource policies from a disk.
5101
5102 Args:
5103 project: string, Project ID for this request. (required)
5104 zone: string, The name of the zone for this request. (required)
5105 disk: string, The disk name for this request. (required)
5106 body: object, The request body.
5107 The object takes the form of:
5108
5109 {
5110 &quot;resourcePolicies&quot;: [ # Resource policies to be removed from this disk.
5111 &quot;A String&quot;,
5112 ],
5113 }
5114
5115 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5116 that if you must retry your request, the server will know to ignore the
5117 request if it has already been completed.
5118
5119 For example, consider a situation where you make an initial request and
5120 the request times out. If you make the request again with the same
5121 request ID, the server can check if original operation with the same
5122 request ID was received, and if so, will ignore the second request. This
5123 prevents clients from accidentally creating duplicate commitments.
5124
5125 The request ID must be
5126 a valid UUID with the exception that zero UUID is not supported
5127 (00000000-0000-0000-0000-000000000000).
5128 x__xgafv: string, V1 error format.
5129 Allowed values
5130 1 - v1 error format
5131 2 - v2 error format
5132
5133 Returns:
5134 An object of the form:
5135
5136 { # Represents an Operation resource.
5137 #
5138 # Google Compute Engine has three Operation resources:
5139 #
5140 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5141 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5142 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5143 #
5144 # You can use an operation resource to manage asynchronous API requests.
5145 # For more information, readHandling
5146 # API responses.
5147 #
5148 # Operations can be global, regional or zonal.
5149 #
5150 # - For global operations, use the `globalOperations`
5151 # resource.
5152 # - For regional operations, use the
5153 # `regionOperations` resource.
5154 # - For zonal operations, use
5155 # the `zoneOperations` resource.
5156 #
5157 #
5158 #
5159 # For more information, read
5160 # Global, Regional, and Zonal Resources.
5161 #
5162 # Note that completed Operation resources have a limited
5163 # retention period.
5164 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5165 # Not present otherwise.
5166 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5167 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5168 # set when the operation is created.
5169 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5170 # text format.
5171 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5172 # this field will be populated.
5173 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5174 # operation.
5175 {
5176 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5177 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5178 # details. There is a set of defined message types to use for providing
5179 # details.The syntax depends on the error code. For example,
5180 # QuotaExceededInfo will have details when the error code is
5181 # QUOTA_EXCEEDED.
5182 {
5183 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5184 #
5185 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5186 # is not enabled:
5187 #
5188 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5189 # &quot;domain&quot;: &quot;googleapis.com&quot;
5190 # &quot;metadata&quot;: {
5191 # &quot;resource&quot;: &quot;projects/123&quot;,
5192 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5193 # }
5194 # }
5195 #
5196 # This response indicates that the pubsub.googleapis.com API is not enabled.
5197 #
5198 # Example of an error that is returned when attempting to create a Spanner
5199 # instance in a region that is out of stock:
5200 #
5201 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5202 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5203 # &quot;metadata&quot;: {
5204 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5205 # }
5206 # }
5207 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5208 # is typically the registered service name of the tool or product that
5209 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5210 # generated by some common infrastructure, the error domain must be a
5211 # globally unique value that identifies the infrastructure. For Google API
5212 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5213 &quot;metadatas&quot;: { # Additional structured details about this error.
5214 #
5215 # Keys must match a regular expression of `a-z+` but should
5216 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5217 # length. When identifying the current value of an exceeded limit, the units
5218 # should be contained in the key, not the value. For example, rather than
5219 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5220 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5221 # instances that can be created in a single (batch) request.
5222 &quot;a_key&quot;: &quot;A String&quot;,
5223 },
5224 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5225 # proximate cause of the error. Error reasons are unique within a particular
5226 # domain of errors. This should be at most 63 characters and match a
5227 # regular expression of `A-Z+[A-Z0-9]`, which represents
5228 # UPPER_SNAKE_CASE.
5229 },
5230 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5231 #
5232 # For example, if a quota check failed with an error indicating the calling
5233 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5234 # directly to the right place in the developer console to flip the bit.
5235 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5236 { # Describes a URL link.
5237 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5238 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5239 },
5240 ],
5241 },
5242 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5243 # which can be attached to an RPC error.
5244 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5245 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5246 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5247 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5248 },
5249 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5250 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5251 &quot;a_key&quot;: &quot;A String&quot;,
5252 },
5253 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5254 # type or metric.
5255 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5256 # or metric.
5257 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5258 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5259 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5260 },
5261 },
5262 ],
5263 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5264 # This property is optional.
5265 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5266 },
5267 ],
5268 },
5269 &quot;getVersionOperationMetadata&quot;: {
5270 &quot;inlineSbomInfo&quot;: {
5271 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5272 # appropriate identifiers.
5273 &quot;a_key&quot;: &quot;A String&quot;,
5274 },
5275 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5276 # identifiers.
5277 &quot;a_key&quot;: &quot;A String&quot;,
5278 },
5279 },
5280 },
5281 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5282 # message that was returned, such as `NOT FOUND`.
5283 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5284 # status code that was returned. For example, a `404` means the
5285 # resource was not found.
5286 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5287 # defined by the server.
5288 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5289 # This value is inRFC3339
5290 # text format.
5291 &quot;instancesBulkInsertOperationMetadata&quot;: {
5292 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5293 # Example key: zones/us-central1-a
5294 &quot;a_key&quot;: {
5295 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5296 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5297 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5298 # error.
5299 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5300 # if the flow is rolling forward or rolling back.
5301 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5302 },
5303 },
5304 },
5305 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5306 # Operation resources.
5307 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5308 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5309 # group of operations results from a `bulkInsert` API request.
5310 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5311 # `update`, or `delete`, and so on.
5312 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5313 # There is no requirement that this be linear or support any granularity of
5314 # operations. This should not be used to guess when the operation will be
5315 # complete. This number should monotonically increase as the operation
5316 # progresses.
5317 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5318 # applicable when performing regional operations.
5319 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5320 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5321 # this field will contain information on all underlying zonal actions and
5322 # their state.
5323 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5324 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5325 # Example key: zones/us-central1-a
5326 &quot;a_key&quot;: {
5327 &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
5328 # populated.
5329 # different programming environments, including REST APIs and RPC APIs. It is
5330 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5331 # three pieces of data: error code, error message, and error details.
5332 #
5333 # You can find out more about this error model and how to work with it in the
5334 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5335 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5336 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5337 # message types for APIs to use.
5338 {
5339 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5340 },
5341 ],
5342 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5343 # user-facing error message should be localized and sent in the
5344 # google.rpc.Status.details field, or localized by the client.
5345 },
5346 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5347 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5348 },
5349 },
5350 },
5351 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5352 # This value is inRFC3339
5353 # text format.
5354 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5355 # following:
5356 # `PENDING`, `RUNNING`, or `DONE`.
5357 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5358 # operation.
5359 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5360 # of the target resource.
5361 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5362 # operations related to creating a snapshot, this points to the disk
5363 # that the snapshot was created from.
5364 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5365 # `[email protected]` or
5366 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5367 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5368 # operation, this field will be populated.
5369 {
5370 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5371 # Engine returns NO_RESULTS_ON_PAGE if there
5372 # are no results in the response.
5373 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5374 # value format. For example:
5375 #
5376 # &quot;data&quot;: [
5377 # {
5378 # &quot;key&quot;: &quot;scope&quot;,
5379 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5380 # }
5381 {
5382 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5383 # returned. For example, for warnings where there are no results in a list
5384 # request for a particular zone, this key might be scope and
5385 # the key value might be the zone name. Other examples might be a key
5386 # indicating a deprecated resource and a suggested replacement, or a
5387 # warning about invalid network settings (for example, if an instance
5388 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5389 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5390 },
5391 ],
5392 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5393 },
5394 ],
5395 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5396 # applicable when performing per-zone operations.
5397 }</pre>
5398 </div>
5399
5400 <div class="method">
5401 <code class="details" id="resize">resize(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
5402 <pre>Resizes the specified persistent disk.
5403 You can only increase the size of the disk.
5404
5405 Args:
5406 project: string, Project ID for this request. (required)
5407 zone: string, The name of the zone for this request. (required)
5408 disk: string, The name of the persistent disk. (required)
5409 body: object, The request body.
5410 The object takes the form of:
5411
5412 {
5413 &quot;sizeGb&quot;: &quot;A String&quot;, # The new size of the persistent disk, which is specified in GB.
5414 }
5415
5416 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
5417 that if you must retry your request, the server will know to ignore the
5418 request if it has already been completed.
5419
5420 For example, consider a situation where you make an initial request and
5421 the request times out. If you make the request again with the same
5422 request ID, the server can check if original operation with the same
5423 request ID was received, and if so, will ignore the second request. This
5424 prevents clients from accidentally creating duplicate commitments.
5425
5426 The request ID must be
5427 a valid UUID with the exception that zero UUID is not supported
5428 (00000000-0000-0000-0000-000000000000).
5429 x__xgafv: string, V1 error format.
5430 Allowed values
5431 1 - v1 error format
5432 2 - v2 error format
5433
5434 Returns:
5435 An object of the form:
5436
5437 { # Represents an Operation resource.
5438 #
5439 # Google Compute Engine has three Operation resources:
5440 #
5441 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
5442 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
5443 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
5444 #
5445 # You can use an operation resource to manage asynchronous API requests.
5446 # For more information, readHandling
5447 # API responses.
5448 #
5449 # Operations can be global, regional or zonal.
5450 #
5451 # - For global operations, use the `globalOperations`
5452 # resource.
5453 # - For regional operations, use the
5454 # `regionOperations` resource.
5455 # - For zonal operations, use
5456 # the `zoneOperations` resource.
5457 #
5458 #
5459 #
5460 # For more information, read
5461 # Global, Regional, and Zonal Resources.
5462 #
5463 # Note that completed Operation resources have a limited
5464 # retention period.
5465 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
5466 # Not present otherwise.
5467 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
5468 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
5469 # set when the operation is created.
5470 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
5471 # text format.
5472 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
5473 # this field will be populated.
5474 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
5475 # operation.
5476 {
5477 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
5478 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
5479 # details. There is a set of defined message types to use for providing
5480 # details.The syntax depends on the error code. For example,
5481 # QuotaExceededInfo will have details when the error code is
5482 # QUOTA_EXCEEDED.
5483 {
5484 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
5485 #
5486 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
5487 # is not enabled:
5488 #
5489 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
5490 # &quot;domain&quot;: &quot;googleapis.com&quot;
5491 # &quot;metadata&quot;: {
5492 # &quot;resource&quot;: &quot;projects/123&quot;,
5493 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
5494 # }
5495 # }
5496 #
5497 # This response indicates that the pubsub.googleapis.com API is not enabled.
5498 #
5499 # Example of an error that is returned when attempting to create a Spanner
5500 # instance in a region that is out of stock:
5501 #
5502 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
5503 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
5504 # &quot;metadata&quot;: {
5505 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
5506 # }
5507 # }
5508 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
5509 # is typically the registered service name of the tool or product that
5510 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
5511 # generated by some common infrastructure, the error domain must be a
5512 # globally unique value that identifies the infrastructure. For Google API
5513 # infrastructure, the error domain is &quot;googleapis.com&quot;.
5514 &quot;metadatas&quot;: { # Additional structured details about this error.
5515 #
5516 # Keys must match a regular expression of `a-z+` but should
5517 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
5518 # length. When identifying the current value of an exceeded limit, the units
5519 # should be contained in the key, not the value. For example, rather than
5520 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
5521 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
5522 # instances that can be created in a single (batch) request.
5523 &quot;a_key&quot;: &quot;A String&quot;,
5524 },
5525 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
5526 # proximate cause of the error. Error reasons are unique within a particular
5527 # domain of errors. This should be at most 63 characters and match a
5528 # regular expression of `A-Z+[A-Z0-9]`, which represents
5529 # UPPER_SNAKE_CASE.
5530 },
5531 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
5532 #
5533 # For example, if a quota check failed with an error indicating the calling
5534 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
5535 # directly to the right place in the developer console to flip the bit.
5536 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
5537 { # Describes a URL link.
5538 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
5539 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
5540 },
5541 ],
5542 },
5543 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
5544 # which can be attached to an RPC error.
5545 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
5546 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
5547 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
5548 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
5549 },
5550 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
5551 &quot;dimensions&quot;: { # The map holding related quota dimensions.
5552 &quot;a_key&quot;: &quot;A String&quot;,
5553 },
5554 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
5555 # type or metric.
5556 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
5557 # or metric.
5558 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
5559 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
5560 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
5561 },
5562 },
5563 ],
5564 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
5565 # This property is optional.
5566 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
5567 },
5568 ],
5569 },
5570 &quot;getVersionOperationMetadata&quot;: {
5571 &quot;inlineSbomInfo&quot;: {
5572 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
5573 # appropriate identifiers.
5574 &quot;a_key&quot;: &quot;A String&quot;,
5575 },
5576 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
5577 # identifiers.
5578 &quot;a_key&quot;: &quot;A String&quot;,
5579 },
5580 },
5581 },
5582 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
5583 # message that was returned, such as `NOT FOUND`.
5584 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
5585 # status code that was returned. For example, a `404` means the
5586 # resource was not found.
5587 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
5588 # defined by the server.
5589 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
5590 # This value is inRFC3339
5591 # text format.
5592 &quot;instancesBulkInsertOperationMetadata&quot;: {
5593 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
5594 # Example key: zones/us-central1-a
5595 &quot;a_key&quot;: {
5596 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
5597 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
5598 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
5599 # error.
5600 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
5601 # if the flow is rolling forward or rolling back.
5602 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
5603 },
5604 },
5605 },
5606 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
5607 # Operation resources.
5608 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
5609 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
5610 # group of operations results from a `bulkInsert` API request.
5611 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
5612 # `update`, or `delete`, and so on.
5613 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
5614 # There is no requirement that this be linear or support any granularity of
5615 # operations. This should not be used to guess when the operation will be
5616 # complete. This number should monotonically increase as the operation
5617 # progresses.
5618 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
5619 # applicable when performing regional operations.
5620 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
5621 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
5622 # this field will contain information on all underlying zonal actions and
5623 # their state.
5624 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
5625 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
5626 # Example key: zones/us-central1-a
5627 &quot;a_key&quot;: {
5628 &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
5629 # populated.
5630 # different programming environments, including REST APIs and RPC APIs. It is
5631 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5632 # three pieces of data: error code, error message, and error details.
5633 #
5634 # You can find out more about this error model and how to work with it in the
5635 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5636 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
5637 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
5638 # message types for APIs to use.
5639 {
5640 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
5641 },
5642 ],
5643 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
5644 # user-facing error message should be localized and sent in the
5645 # google.rpc.Status.details field, or localized by the client.
5646 },
5647 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
5648 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
5649 },
5650 },
5651 },
5652 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
5653 # This value is inRFC3339
5654 # text format.
5655 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
5656 # following:
5657 # `PENDING`, `RUNNING`, or `DONE`.
5658 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
5659 # operation.
5660 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
5661 # of the target resource.
5662 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
5663 # operations related to creating a snapshot, this points to the disk
5664 # that the snapshot was created from.
5665 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
5666 # `[email protected]` or
5667 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
5668 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
5669 # operation, this field will be populated.
5670 {
5671 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
5672 # Engine returns NO_RESULTS_ON_PAGE if there
5673 # are no results in the response.
5674 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
5675 # value format. For example:
5676 #
5677 # &quot;data&quot;: [
5678 # {
5679 # &quot;key&quot;: &quot;scope&quot;,
5680 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
5681 # }
5682 {
5683 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
5684 # returned. For example, for warnings where there are no results in a list
5685 # request for a particular zone, this key might be scope and
5686 # the key value might be the zone name. Other examples might be a key
5687 # indicating a deprecated resource and a suggested replacement, or a
5688 # warning about invalid network settings (for example, if an instance
5689 # attempts to perform IP forwarding but is not enabled for IP forwarding).
5690 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
5691 },
5692 ],
5693 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
5694 },
5695 ],
5696 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
5697 # applicable when performing per-zone operations.
5698 }</pre>
5699 </div>
5700
5701 <div class="method">
5702 <code class="details" id="setIamPolicy">setIamPolicy(project, zone, resource, body=None, x__xgafv=None)</code>
5703 <pre>Sets the access control policy on the specified resource.
5704 Replaces any existing policy.
5705
5706 Args:
5707 project: string, Project ID for this request. (required)
5708 zone: string, The name of the zone for this request. (required)
5709 resource: string, Name or id of the resource for this request. (required)
5710 body: object, The request body.
5711 The object takes the form of:
5712
5713 {
5714 &quot;bindings&quot;: [ # Flatten Policy to create a backwacd compatible wire-format.
5715 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
5716 { # Associates `members`, or principals, with a `role`.
5717 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
5718 #
5719 # If the condition evaluates to `true`, then this binding applies to the
5720 # current request.
5721 #
5722 # If the condition evaluates to `false`, then this binding does not apply to
5723 # the current request. However, a different role binding might grant the same
5724 # role to one or more of the principals in this binding.
5725 #
5726 # To learn which resources support conditions in their IAM policies, see the
5727 # [IAM
5728 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5729 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
5730 # are documented at https://github.com/google/cel-spec.
5731 #
5732 # Example (Comparison):
5733 #
5734 # title: &quot;Summary size limit&quot;
5735 # description: &quot;Determines if a summary is less than 100 chars&quot;
5736 # expression: &quot;document.summary.size() &lt; 100&quot;
5737 #
5738 # Example (Equality):
5739 #
5740 # title: &quot;Requestor is owner&quot;
5741 # description: &quot;Determines if requestor is the document owner&quot;
5742 # expression: &quot;document.owner == request.auth.claims.email&quot;
5743 #
5744 # Example (Logic):
5745 #
5746 # title: &quot;Public documents&quot;
5747 # description: &quot;Determine whether the document should be publicly visible&quot;
5748 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
5749 #
5750 # Example (Data Manipulation):
5751 #
5752 # title: &quot;Notification string&quot;
5753 # description: &quot;Create a notification string with a timestamp.&quot;
5754 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
5755 #
5756 # The exact variables and functions that may be referenced within an expression
5757 # are determined by the service that evaluates it. See the service
5758 # documentation for additional information.
5759 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
5760 # describes the expression, e.g. when hovered over it in a UI.
5761 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
5762 # syntax.
5763 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
5764 # reporting, e.g. a file name and a position in the file.
5765 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
5766 # its purpose. This can be used e.g. in UIs which allow to enter the
5767 # expression.
5768 },
5769 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
5770 # `members` can have the following values:
5771 #
5772 # * `allUsers`: A special identifier that represents anyone who is
5773 # on the internet; with or without a Google account.
5774 #
5775 # * `allAuthenticatedUsers`: A special identifier that represents anyone
5776 # who is authenticated with a Google account or a service account.
5777 # Does not include identities that come from external identity providers
5778 # (IdPs) through identity federation.
5779 #
5780 # * `user:{emailid}`: An email address that represents a specific Google
5781 # account. For example, `[email protected]` .
5782 #
5783 #
5784 # * `serviceAccount:{emailid}`: An email address that represents a Google
5785 # service account. For example,
5786 # `[email protected]`.
5787 #
5788 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
5789 # identifier for a
5790 # [Kubernetes service
5791 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
5792 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
5793 #
5794 # * `group:{emailid}`: An email address that represents a Google group.
5795 # For example, `[email protected]`.
5796 #
5797 #
5798 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
5799 # users of that domain. For example, `google.com` or `example.com`.
5800 #
5801 #
5802 #
5803 #
5804 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5805 # A single identity in a workforce identity pool.
5806 #
5807 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
5808 # All workforce identities in a group.
5809 #
5810 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5811 # All workforce identities with a specific attribute value.
5812 #
5813 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
5814 # All identities in a workforce identity pool.
5815 #
5816 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
5817 # A single identity in a workload identity pool.
5818 #
5819 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
5820 # A workload identity pool group.
5821 #
5822 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
5823 # All identities in a workload identity pool with a certain attribute.
5824 #
5825 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
5826 # All identities in a workload identity pool.
5827 #
5828 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
5829 # identifier) representing a user that has been recently deleted. For
5830 # example, `[email protected]?uid=123456789012345678901`. If the user is
5831 # recovered, this value reverts to `user:{emailid}` and the recovered user
5832 # retains the role in the binding.
5833 #
5834 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
5835 # unique identifier) representing a service account that has been recently
5836 # deleted. For example,
5837 # `[email protected]?uid=123456789012345678901`.
5838 # If the service account is undeleted, this value reverts to
5839 # `serviceAccount:{emailid}` and the undeleted service account retains the
5840 # role in the binding.
5841 #
5842 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
5843 # identifier) representing a Google group that has been recently
5844 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
5845 # the group is recovered, this value reverts to `group:{emailid}` and the
5846 # recovered group retains the role in the binding.
5847 #
5848 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
5849 # Deleted single identity in a workforce identity pool. For example,
5850 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
5851 &quot;A String&quot;,
5852 ],
5853 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
5854 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
5855 #
5856 # For an overview of the IAM roles and permissions, see the
5857 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
5858 # a list of the available pre-defined roles, see
5859 # [here](https://cloud.google.com/iam/docs/understanding-roles).
5860 },
5861 ],
5862 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
5863 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
5864 &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
5865 # the policy is limited to a few 10s of KB. An empty policy is in general a
5866 # valid policy but certain services (like Projects) might reject them.
5867 # controls for Google Cloud resources.
5868 #
5869 #
5870 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
5871 # `members`, or principals, to a single `role`. Principals can be user
5872 # accounts, service accounts, Google groups, and domains (such as G Suite). A
5873 # `role` is a named list of permissions; each `role` can be an IAM predefined
5874 # role or a user-created custom role.
5875 #
5876 # For some types of Google Cloud resources, a `binding` can also specify a
5877 # `condition`, which is a logical expression that allows access to a resource
5878 # only if the expression evaluates to `true`. A condition can add constraints
5879 # based on attributes of the request, the resource, or both. To learn which
5880 # resources support conditions in their IAM policies, see the
5881 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
5882 #
5883 # **JSON example:**
5884 #
5885 # ```
5886 # {
5887 # &quot;bindings&quot;: [
5888 # {
5889 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
5890 # &quot;members&quot;: [
5891 # &quot;user:[email protected]&quot;,
5892 # &quot;group:[email protected]&quot;,
5893 # &quot;domain:google.com&quot;,
5894 # &quot;serviceAccount:[email protected]&quot;
5895 # ]
5896 # },
5897 # {
5898 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
5899 # &quot;members&quot;: [
5900 # &quot;user:[email protected]&quot;
5901 # ],
5902 # &quot;condition&quot;: {
5903 # &quot;title&quot;: &quot;expirable access&quot;,
5904 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
5905 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
5906 # }
5907 # }
5908 # ],
5909 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
5910 # &quot;version&quot;: 3
5911 # }
5912 # ```
5913 #
5914 # **YAML example:**
5915 #
5916 # ```
5917 # bindings:
5918 # - members:
5919 # - user:[email protected]
5920 # - group:[email protected]
5921 # - domain:google.com
5922 # - serviceAccount:[email protected]
5923 # role: roles/resourcemanager.organizationAdmin
5924 # - members:
5925 # - user:[email protected]
5926 # role: roles/resourcemanager.organizationViewer
5927 # condition:
5928 # title: expirable access
5929 # description: Does not grant access after Sep 2020
5930 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
5931 # etag: BwWWja0YfJA=
5932 # version: 3
5933 # ```
5934 #
5935 # For a description of IAM and its features, see the
5936 # [IAM documentation](https://cloud.google.com/iam/docs/).
5937 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
5938 { # Specifies the audit configuration for a service.
5939 # The configuration determines which permission types are logged, and what
5940 # identities, if any, are exempted from logging.
5941 # An AuditConfig must have one or more AuditLogConfigs.
5942 #
5943 # If there are AuditConfigs for both `allServices` and a specific service,
5944 # the union of the two AuditConfigs is used for that service: the log_types
5945 # specified in each AuditConfig are enabled, and the exempted_members in each
5946 # AuditLogConfig are exempted.
5947 #
5948 # Example Policy with multiple AuditConfigs:
5949 #
5950 # {
5951 # &quot;audit_configs&quot;: [
5952 # {
5953 # &quot;service&quot;: &quot;allServices&quot;,
5954 # &quot;audit_log_configs&quot;: [
5955 # {
5956 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5957 # &quot;exempted_members&quot;: [
5958 # &quot;user:[email protected]&quot;
5959 # ]
5960 # },
5961 # {
5962 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
5963 # },
5964 # {
5965 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
5966 # }
5967 # ]
5968 # },
5969 # {
5970 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
5971 # &quot;audit_log_configs&quot;: [
5972 # {
5973 # &quot;log_type&quot;: &quot;DATA_READ&quot;
5974 # },
5975 # {
5976 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
5977 # &quot;exempted_members&quot;: [
5978 # &quot;user:[email protected]&quot;
5979 # ]
5980 # }
5981 # ]
5982 # }
5983 # ]
5984 # }
5985 #
5986 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
5987 # logging. It also exempts `[email protected]` from DATA_READ logging, and
5988 # `[email protected]` from DATA_WRITE logging.
5989 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
5990 { # Provides the configuration for logging a type of permissions.
5991 # Example:
5992 #
5993 # {
5994 # &quot;audit_log_configs&quot;: [
5995 # {
5996 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
5997 # &quot;exempted_members&quot;: [
5998 # &quot;user:[email protected]&quot;
5999 # ]
6000 # },
6001 # {
6002 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6003 # }
6004 # ]
6005 # }
6006 #
6007 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
6008 # [email protected] from DATA_READ logging.
6009 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
6010 # permission.
6011 # Follows the same format of Binding.members.
6012 &quot;A String&quot;,
6013 ],
6014 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
6015 },
6016 ],
6017 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
6018 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
6019 # `allServices` is a special value that covers all services.
6020 },
6021 ],
6022 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
6023 # may specify a `condition` that determines how and when the `bindings` are
6024 # applied. Each of the `bindings` must contain at least one principal.
6025 #
6026 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
6027 # of these principals can be Google groups. Each occurrence of a principal
6028 # counts towards these limits. For example, if the `bindings` grant 50
6029 # different roles to `user:[email protected]`, and not to any other
6030 # principal, then you can add another 1,450 principals to the `bindings` in
6031 # the `Policy`.
6032 { # Associates `members`, or principals, with a `role`.
6033 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6034 #
6035 # If the condition evaluates to `true`, then this binding applies to the
6036 # current request.
6037 #
6038 # If the condition evaluates to `false`, then this binding does not apply to
6039 # the current request. However, a different role binding might grant the same
6040 # role to one or more of the principals in this binding.
6041 #
6042 # To learn which resources support conditions in their IAM policies, see the
6043 # [IAM
6044 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6045 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6046 # are documented at https://github.com/google/cel-spec.
6047 #
6048 # Example (Comparison):
6049 #
6050 # title: &quot;Summary size limit&quot;
6051 # description: &quot;Determines if a summary is less than 100 chars&quot;
6052 # expression: &quot;document.summary.size() &lt; 100&quot;
6053 #
6054 # Example (Equality):
6055 #
6056 # title: &quot;Requestor is owner&quot;
6057 # description: &quot;Determines if requestor is the document owner&quot;
6058 # expression: &quot;document.owner == request.auth.claims.email&quot;
6059 #
6060 # Example (Logic):
6061 #
6062 # title: &quot;Public documents&quot;
6063 # description: &quot;Determine whether the document should be publicly visible&quot;
6064 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6065 #
6066 # Example (Data Manipulation):
6067 #
6068 # title: &quot;Notification string&quot;
6069 # description: &quot;Create a notification string with a timestamp.&quot;
6070 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6071 #
6072 # The exact variables and functions that may be referenced within an expression
6073 # are determined by the service that evaluates it. See the service
6074 # documentation for additional information.
6075 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6076 # describes the expression, e.g. when hovered over it in a UI.
6077 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6078 # syntax.
6079 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6080 # reporting, e.g. a file name and a position in the file.
6081 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6082 # its purpose. This can be used e.g. in UIs which allow to enter the
6083 # expression.
6084 },
6085 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6086 # `members` can have the following values:
6087 #
6088 # * `allUsers`: A special identifier that represents anyone who is
6089 # on the internet; with or without a Google account.
6090 #
6091 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6092 # who is authenticated with a Google account or a service account.
6093 # Does not include identities that come from external identity providers
6094 # (IdPs) through identity federation.
6095 #
6096 # * `user:{emailid}`: An email address that represents a specific Google
6097 # account. For example, `[email protected]` .
6098 #
6099 #
6100 # * `serviceAccount:{emailid}`: An email address that represents a Google
6101 # service account. For example,
6102 # `[email protected]`.
6103 #
6104 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6105 # identifier for a
6106 # [Kubernetes service
6107 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6108 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6109 #
6110 # * `group:{emailid}`: An email address that represents a Google group.
6111 # For example, `[email protected]`.
6112 #
6113 #
6114 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6115 # users of that domain. For example, `google.com` or `example.com`.
6116 #
6117 #
6118 #
6119 #
6120 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6121 # A single identity in a workforce identity pool.
6122 #
6123 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6124 # All workforce identities in a group.
6125 #
6126 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6127 # All workforce identities with a specific attribute value.
6128 #
6129 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6130 # All identities in a workforce identity pool.
6131 #
6132 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6133 # A single identity in a workload identity pool.
6134 #
6135 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6136 # A workload identity pool group.
6137 #
6138 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6139 # All identities in a workload identity pool with a certain attribute.
6140 #
6141 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6142 # All identities in a workload identity pool.
6143 #
6144 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6145 # identifier) representing a user that has been recently deleted. For
6146 # example, `[email protected]?uid=123456789012345678901`. If the user is
6147 # recovered, this value reverts to `user:{emailid}` and the recovered user
6148 # retains the role in the binding.
6149 #
6150 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6151 # unique identifier) representing a service account that has been recently
6152 # deleted. For example,
6153 # `[email protected]?uid=123456789012345678901`.
6154 # If the service account is undeleted, this value reverts to
6155 # `serviceAccount:{emailid}` and the undeleted service account retains the
6156 # role in the binding.
6157 #
6158 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6159 # identifier) representing a Google group that has been recently
6160 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6161 # the group is recovered, this value reverts to `group:{emailid}` and the
6162 # recovered group retains the role in the binding.
6163 #
6164 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6165 # Deleted single identity in a workforce identity pool. For example,
6166 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6167 &quot;A String&quot;,
6168 ],
6169 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6170 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6171 #
6172 # For an overview of the IAM roles and permissions, see the
6173 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6174 # a list of the available pre-defined roles, see
6175 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6176 },
6177 ],
6178 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6179 # prevent simultaneous updates of a policy from overwriting each other.
6180 # It is strongly suggested that systems make use of the `etag` in the
6181 # read-modify-write cycle to perform policy updates in order to avoid race
6182 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6183 # systems are expected to put that etag in the request to `setIamPolicy` to
6184 # ensure that their change will be applied to the same version of the policy.
6185 #
6186 # **Important:** If you use IAM Conditions, you must include the `etag` field
6187 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6188 # you to overwrite a version `3` policy with a version `1` policy, and all of
6189 # the conditions in the version `3` policy are lost.
6190 &quot;version&quot;: 42, # Specifies the format of the policy.
6191 #
6192 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6193 # are rejected.
6194 #
6195 # Any operation that affects conditional role bindings must specify version
6196 # `3`. This requirement applies to the following operations:
6197 #
6198 # * Getting a policy that includes a conditional role binding
6199 # * Adding a conditional role binding to a policy
6200 # * Changing a conditional role binding in a policy
6201 # * Removing any role binding, with or without a condition, from a policy
6202 # that includes conditions
6203 #
6204 # **Important:** If you use IAM Conditions, you must include the `etag` field
6205 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6206 # you to overwrite a version `3` policy with a version `1` policy, and all of
6207 # the conditions in the version `3` policy are lost.
6208 #
6209 # If a policy does not include any conditions, operations on that policy may
6210 # specify any valid version or leave the field unset.
6211 #
6212 # To learn which resources support conditions in their IAM policies, see the
6213 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6214 },
6215 }
6216
6217 x__xgafv: string, V1 error format.
6218 Allowed values
6219 1 - v1 error format
6220 2 - v2 error format
6221
6222 Returns:
6223 An object of the form:
6224
6225 { # An Identity and Access Management (IAM) policy, which specifies access
6226 # controls for Google Cloud resources.
6227 #
6228 #
6229 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
6230 # `members`, or principals, to a single `role`. Principals can be user
6231 # accounts, service accounts, Google groups, and domains (such as G Suite). A
6232 # `role` is a named list of permissions; each `role` can be an IAM predefined
6233 # role or a user-created custom role.
6234 #
6235 # For some types of Google Cloud resources, a `binding` can also specify a
6236 # `condition`, which is a logical expression that allows access to a resource
6237 # only if the expression evaluates to `true`. A condition can add constraints
6238 # based on attributes of the request, the resource, or both. To learn which
6239 # resources support conditions in their IAM policies, see the
6240 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6241 #
6242 # **JSON example:**
6243 #
6244 # ```
6245 # {
6246 # &quot;bindings&quot;: [
6247 # {
6248 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
6249 # &quot;members&quot;: [
6250 # &quot;user:[email protected]&quot;,
6251 # &quot;group:[email protected]&quot;,
6252 # &quot;domain:google.com&quot;,
6253 # &quot;serviceAccount:[email protected]&quot;
6254 # ]
6255 # },
6256 # {
6257 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
6258 # &quot;members&quot;: [
6259 # &quot;user:[email protected]&quot;
6260 # ],
6261 # &quot;condition&quot;: {
6262 # &quot;title&quot;: &quot;expirable access&quot;,
6263 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
6264 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
6265 # }
6266 # }
6267 # ],
6268 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
6269 # &quot;version&quot;: 3
6270 # }
6271 # ```
6272 #
6273 # **YAML example:**
6274 #
6275 # ```
6276 # bindings:
6277 # - members:
6278 # - user:[email protected]
6279 # - group:[email protected]
6280 # - domain:google.com
6281 # - serviceAccount:[email protected]
6282 # role: roles/resourcemanager.organizationAdmin
6283 # - members:
6284 # - user:[email protected]
6285 # role: roles/resourcemanager.organizationViewer
6286 # condition:
6287 # title: expirable access
6288 # description: Does not grant access after Sep 2020
6289 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
6290 # etag: BwWWja0YfJA=
6291 # version: 3
6292 # ```
6293 #
6294 # For a description of IAM and its features, see the
6295 # [IAM documentation](https://cloud.google.com/iam/docs/).
6296 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
6297 { # Specifies the audit configuration for a service.
6298 # The configuration determines which permission types are logged, and what
6299 # identities, if any, are exempted from logging.
6300 # An AuditConfig must have one or more AuditLogConfigs.
6301 #
6302 # If there are AuditConfigs for both `allServices` and a specific service,
6303 # the union of the two AuditConfigs is used for that service: the log_types
6304 # specified in each AuditConfig are enabled, and the exempted_members in each
6305 # AuditLogConfig are exempted.
6306 #
6307 # Example Policy with multiple AuditConfigs:
6308 #
6309 # {
6310 # &quot;audit_configs&quot;: [
6311 # {
6312 # &quot;service&quot;: &quot;allServices&quot;,
6313 # &quot;audit_log_configs&quot;: [
6314 # {
6315 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6316 # &quot;exempted_members&quot;: [
6317 # &quot;user:[email protected]&quot;
6318 # ]
6319 # },
6320 # {
6321 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6322 # },
6323 # {
6324 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
6325 # }
6326 # ]
6327 # },
6328 # {
6329 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
6330 # &quot;audit_log_configs&quot;: [
6331 # {
6332 # &quot;log_type&quot;: &quot;DATA_READ&quot;
6333 # },
6334 # {
6335 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
6336 # &quot;exempted_members&quot;: [
6337 # &quot;user:[email protected]&quot;
6338 # ]
6339 # }
6340 # ]
6341 # }
6342 # ]
6343 # }
6344 #
6345 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
6346 # logging. It also exempts `[email protected]` from DATA_READ logging, and
6347 # `[email protected]` from DATA_WRITE logging.
6348 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
6349 { # Provides the configuration for logging a type of permissions.
6350 # Example:
6351 #
6352 # {
6353 # &quot;audit_log_configs&quot;: [
6354 # {
6355 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
6356 # &quot;exempted_members&quot;: [
6357 # &quot;user:[email protected]&quot;
6358 # ]
6359 # },
6360 # {
6361 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
6362 # }
6363 # ]
6364 # }
6365 #
6366 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
6367 # [email protected] from DATA_READ logging.
6368 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
6369 # permission.
6370 # Follows the same format of Binding.members.
6371 &quot;A String&quot;,
6372 ],
6373 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
6374 },
6375 ],
6376 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
6377 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
6378 # `allServices` is a special value that covers all services.
6379 },
6380 ],
6381 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
6382 # may specify a `condition` that determines how and when the `bindings` are
6383 # applied. Each of the `bindings` must contain at least one principal.
6384 #
6385 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
6386 # of these principals can be Google groups. Each occurrence of a principal
6387 # counts towards these limits. For example, if the `bindings` grant 50
6388 # different roles to `user:[email protected]`, and not to any other
6389 # principal, then you can add another 1,450 principals to the `bindings` in
6390 # the `Policy`.
6391 { # Associates `members`, or principals, with a `role`.
6392 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
6393 #
6394 # If the condition evaluates to `true`, then this binding applies to the
6395 # current request.
6396 #
6397 # If the condition evaluates to `false`, then this binding does not apply to
6398 # the current request. However, a different role binding might grant the same
6399 # role to one or more of the principals in this binding.
6400 #
6401 # To learn which resources support conditions in their IAM policies, see the
6402 # [IAM
6403 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6404 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
6405 # are documented at https://github.com/google/cel-spec.
6406 #
6407 # Example (Comparison):
6408 #
6409 # title: &quot;Summary size limit&quot;
6410 # description: &quot;Determines if a summary is less than 100 chars&quot;
6411 # expression: &quot;document.summary.size() &lt; 100&quot;
6412 #
6413 # Example (Equality):
6414 #
6415 # title: &quot;Requestor is owner&quot;
6416 # description: &quot;Determines if requestor is the document owner&quot;
6417 # expression: &quot;document.owner == request.auth.claims.email&quot;
6418 #
6419 # Example (Logic):
6420 #
6421 # title: &quot;Public documents&quot;
6422 # description: &quot;Determine whether the document should be publicly visible&quot;
6423 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
6424 #
6425 # Example (Data Manipulation):
6426 #
6427 # title: &quot;Notification string&quot;
6428 # description: &quot;Create a notification string with a timestamp.&quot;
6429 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
6430 #
6431 # The exact variables and functions that may be referenced within an expression
6432 # are determined by the service that evaluates it. See the service
6433 # documentation for additional information.
6434 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
6435 # describes the expression, e.g. when hovered over it in a UI.
6436 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
6437 # syntax.
6438 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
6439 # reporting, e.g. a file name and a position in the file.
6440 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
6441 # its purpose. This can be used e.g. in UIs which allow to enter the
6442 # expression.
6443 },
6444 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
6445 # `members` can have the following values:
6446 #
6447 # * `allUsers`: A special identifier that represents anyone who is
6448 # on the internet; with or without a Google account.
6449 #
6450 # * `allAuthenticatedUsers`: A special identifier that represents anyone
6451 # who is authenticated with a Google account or a service account.
6452 # Does not include identities that come from external identity providers
6453 # (IdPs) through identity federation.
6454 #
6455 # * `user:{emailid}`: An email address that represents a specific Google
6456 # account. For example, `[email protected]` .
6457 #
6458 #
6459 # * `serviceAccount:{emailid}`: An email address that represents a Google
6460 # service account. For example,
6461 # `[email protected]`.
6462 #
6463 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
6464 # identifier for a
6465 # [Kubernetes service
6466 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
6467 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
6468 #
6469 # * `group:{emailid}`: An email address that represents a Google group.
6470 # For example, `[email protected]`.
6471 #
6472 #
6473 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
6474 # users of that domain. For example, `google.com` or `example.com`.
6475 #
6476 #
6477 #
6478 #
6479 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6480 # A single identity in a workforce identity pool.
6481 #
6482 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
6483 # All workforce identities in a group.
6484 #
6485 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6486 # All workforce identities with a specific attribute value.
6487 #
6488 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
6489 # All identities in a workforce identity pool.
6490 #
6491 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
6492 # A single identity in a workload identity pool.
6493 #
6494 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
6495 # A workload identity pool group.
6496 #
6497 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
6498 # All identities in a workload identity pool with a certain attribute.
6499 #
6500 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
6501 # All identities in a workload identity pool.
6502 #
6503 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
6504 # identifier) representing a user that has been recently deleted. For
6505 # example, `[email protected]?uid=123456789012345678901`. If the user is
6506 # recovered, this value reverts to `user:{emailid}` and the recovered user
6507 # retains the role in the binding.
6508 #
6509 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
6510 # unique identifier) representing a service account that has been recently
6511 # deleted. For example,
6512 # `[email protected]?uid=123456789012345678901`.
6513 # If the service account is undeleted, this value reverts to
6514 # `serviceAccount:{emailid}` and the undeleted service account retains the
6515 # role in the binding.
6516 #
6517 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
6518 # identifier) representing a Google group that has been recently
6519 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
6520 # the group is recovered, this value reverts to `group:{emailid}` and the
6521 # recovered group retains the role in the binding.
6522 #
6523 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
6524 # Deleted single identity in a workforce identity pool. For example,
6525 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
6526 &quot;A String&quot;,
6527 ],
6528 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
6529 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
6530 #
6531 # For an overview of the IAM roles and permissions, see the
6532 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
6533 # a list of the available pre-defined roles, see
6534 # [here](https://cloud.google.com/iam/docs/understanding-roles).
6535 },
6536 ],
6537 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
6538 # prevent simultaneous updates of a policy from overwriting each other.
6539 # It is strongly suggested that systems make use of the `etag` in the
6540 # read-modify-write cycle to perform policy updates in order to avoid race
6541 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
6542 # systems are expected to put that etag in the request to `setIamPolicy` to
6543 # ensure that their change will be applied to the same version of the policy.
6544 #
6545 # **Important:** If you use IAM Conditions, you must include the `etag` field
6546 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6547 # you to overwrite a version `3` policy with a version `1` policy, and all of
6548 # the conditions in the version `3` policy are lost.
6549 &quot;version&quot;: 42, # Specifies the format of the policy.
6550 #
6551 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
6552 # are rejected.
6553 #
6554 # Any operation that affects conditional role bindings must specify version
6555 # `3`. This requirement applies to the following operations:
6556 #
6557 # * Getting a policy that includes a conditional role binding
6558 # * Adding a conditional role binding to a policy
6559 # * Changing a conditional role binding in a policy
6560 # * Removing any role binding, with or without a condition, from a policy
6561 # that includes conditions
6562 #
6563 # **Important:** If you use IAM Conditions, you must include the `etag` field
6564 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
6565 # you to overwrite a version `3` policy with a version `1` policy, and all of
6566 # the conditions in the version `3` policy are lost.
6567 #
6568 # If a policy does not include any conditions, operations on that policy may
6569 # specify any valid version or leave the field unset.
6570 #
6571 # To learn which resources support conditions in their IAM policies, see the
6572 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
6573 }</pre>
6574 </div>
6575
6576 <div class="method">
6577 <code class="details" id="setLabels">setLabels(project, zone, resource, body=None, requestId=None, x__xgafv=None)</code>
6578 <pre>Sets the labels on a disk. To learn more about labels, read theLabeling
6579 Resources documentation.
6580
6581 Args:
6582 project: string, Project ID for this request. (required)
6583 zone: string, The name of the zone for this request. (required)
6584 resource: string, Name or id of the resource for this request. (required)
6585 body: object, The request body.
6586 The object takes the form of:
6587
6588 {
6589 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
6590 # used to detect conflicts. The fingerprint is initially generated by Compute
6591 # Engine and changes after every request to modify or update labels. You must
6592 # always provide an up-to-date fingerprint hash in order to update or change
6593 # labels. Make a get() request to the resource to get the latest
6594 # fingerprint.
6595 &quot;labels&quot;: { # The labels to set for this resource.
6596 &quot;a_key&quot;: &quot;A String&quot;,
6597 },
6598 }
6599
6600 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6601 that if you must retry your request, the server will know to ignore the
6602 request if it has already been completed.
6603
6604 For example, consider a situation where you make an initial request and
6605 the request times out. If you make the request again with the same
6606 request ID, the server can check if original operation with the same
6607 request ID was received, and if so, will ignore the second request. This
6608 prevents clients from accidentally creating duplicate commitments.
6609
6610 The request ID must be
6611 a valid UUID with the exception that zero UUID is not supported
6612 (00000000-0000-0000-0000-000000000000).
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 { # Represents an Operation resource.
6622 #
6623 # Google Compute Engine has three Operation resources:
6624 #
6625 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
6626 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
6627 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
6628 #
6629 # You can use an operation resource to manage asynchronous API requests.
6630 # For more information, readHandling
6631 # API responses.
6632 #
6633 # Operations can be global, regional or zonal.
6634 #
6635 # - For global operations, use the `globalOperations`
6636 # resource.
6637 # - For regional operations, use the
6638 # `regionOperations` resource.
6639 # - For zonal operations, use
6640 # the `zoneOperations` resource.
6641 #
6642 #
6643 #
6644 # For more information, read
6645 # Global, Regional, and Zonal Resources.
6646 #
6647 # Note that completed Operation resources have a limited
6648 # retention period.
6649 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6650 # Not present otherwise.
6651 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6652 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6653 # set when the operation is created.
6654 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6655 # text format.
6656 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6657 # this field will be populated.
6658 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6659 # operation.
6660 {
6661 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6662 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6663 # details. There is a set of defined message types to use for providing
6664 # details.The syntax depends on the error code. For example,
6665 # QuotaExceededInfo will have details when the error code is
6666 # QUOTA_EXCEEDED.
6667 {
6668 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6669 #
6670 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6671 # is not enabled:
6672 #
6673 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6674 # &quot;domain&quot;: &quot;googleapis.com&quot;
6675 # &quot;metadata&quot;: {
6676 # &quot;resource&quot;: &quot;projects/123&quot;,
6677 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
6678 # }
6679 # }
6680 #
6681 # This response indicates that the pubsub.googleapis.com API is not enabled.
6682 #
6683 # Example of an error that is returned when attempting to create a Spanner
6684 # instance in a region that is out of stock:
6685 #
6686 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
6687 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
6688 # &quot;metadata&quot;: {
6689 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
6690 # }
6691 # }
6692 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
6693 # is typically the registered service name of the tool or product that
6694 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
6695 # generated by some common infrastructure, the error domain must be a
6696 # globally unique value that identifies the infrastructure. For Google API
6697 # infrastructure, the error domain is &quot;googleapis.com&quot;.
6698 &quot;metadatas&quot;: { # Additional structured details about this error.
6699 #
6700 # Keys must match a regular expression of `a-z+` but should
6701 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
6702 # length. When identifying the current value of an exceeded limit, the units
6703 # should be contained in the key, not the value. For example, rather than
6704 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
6705 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
6706 # instances that can be created in a single (batch) request.
6707 &quot;a_key&quot;: &quot;A String&quot;,
6708 },
6709 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
6710 # proximate cause of the error. Error reasons are unique within a particular
6711 # domain of errors. This should be at most 63 characters and match a
6712 # regular expression of `A-Z+[A-Z0-9]`, which represents
6713 # UPPER_SNAKE_CASE.
6714 },
6715 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
6716 #
6717 # For example, if a quota check failed with an error indicating the calling
6718 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
6719 # directly to the right place in the developer console to flip the bit.
6720 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
6721 { # Describes a URL link.
6722 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
6723 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
6724 },
6725 ],
6726 },
6727 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
6728 # which can be attached to an RPC error.
6729 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
6730 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
6731 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
6732 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
6733 },
6734 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
6735 &quot;dimensions&quot;: { # The map holding related quota dimensions.
6736 &quot;a_key&quot;: &quot;A String&quot;,
6737 },
6738 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
6739 # type or metric.
6740 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
6741 # or metric.
6742 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
6743 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
6744 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
6745 },
6746 },
6747 ],
6748 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
6749 # This property is optional.
6750 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
6751 },
6752 ],
6753 },
6754 &quot;getVersionOperationMetadata&quot;: {
6755 &quot;inlineSbomInfo&quot;: {
6756 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
6757 # appropriate identifiers.
6758 &quot;a_key&quot;: &quot;A String&quot;,
6759 },
6760 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
6761 # identifiers.
6762 &quot;a_key&quot;: &quot;A String&quot;,
6763 },
6764 },
6765 },
6766 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
6767 # message that was returned, such as `NOT FOUND`.
6768 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
6769 # status code that was returned. For example, a `404` means the
6770 # resource was not found.
6771 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
6772 # defined by the server.
6773 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
6774 # This value is inRFC3339
6775 # text format.
6776 &quot;instancesBulkInsertOperationMetadata&quot;: {
6777 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
6778 # Example key: zones/us-central1-a
6779 &quot;a_key&quot;: {
6780 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
6781 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
6782 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
6783 # error.
6784 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
6785 # if the flow is rolling forward or rolling back.
6786 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
6787 },
6788 },
6789 },
6790 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
6791 # Operation resources.
6792 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
6793 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
6794 # group of operations results from a `bulkInsert` API request.
6795 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
6796 # `update`, or `delete`, and so on.
6797 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
6798 # There is no requirement that this be linear or support any granularity of
6799 # operations. This should not be used to guess when the operation will be
6800 # complete. This number should monotonically increase as the operation
6801 # progresses.
6802 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
6803 # applicable when performing regional operations.
6804 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
6805 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
6806 # this field will contain information on all underlying zonal actions and
6807 # their state.
6808 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
6809 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
6810 # Example key: zones/us-central1-a
6811 &quot;a_key&quot;: {
6812 &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
6813 # populated.
6814 # different programming environments, including REST APIs and RPC APIs. It is
6815 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
6816 # three pieces of data: error code, error message, and error details.
6817 #
6818 # You can find out more about this error model and how to work with it in the
6819 # [API Design Guide](https://cloud.google.com/apis/design/errors).
6820 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
6821 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
6822 # message types for APIs to use.
6823 {
6824 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
6825 },
6826 ],
6827 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
6828 # user-facing error message should be localized and sent in the
6829 # google.rpc.Status.details field, or localized by the client.
6830 },
6831 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
6832 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
6833 },
6834 },
6835 },
6836 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
6837 # This value is inRFC3339
6838 # text format.
6839 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
6840 # following:
6841 # `PENDING`, `RUNNING`, or `DONE`.
6842 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
6843 # operation.
6844 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
6845 # of the target resource.
6846 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
6847 # operations related to creating a snapshot, this points to the disk
6848 # that the snapshot was created from.
6849 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
6850 # `[email protected]` or
6851 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
6852 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
6853 # operation, this field will be populated.
6854 {
6855 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
6856 # Engine returns NO_RESULTS_ON_PAGE if there
6857 # are no results in the response.
6858 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
6859 # value format. For example:
6860 #
6861 # &quot;data&quot;: [
6862 # {
6863 # &quot;key&quot;: &quot;scope&quot;,
6864 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
6865 # }
6866 {
6867 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
6868 # returned. For example, for warnings where there are no results in a list
6869 # request for a particular zone, this key might be scope and
6870 # the key value might be the zone name. Other examples might be a key
6871 # indicating a deprecated resource and a suggested replacement, or a
6872 # warning about invalid network settings (for example, if an instance
6873 # attempts to perform IP forwarding but is not enabled for IP forwarding).
6874 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
6875 },
6876 ],
6877 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
6878 },
6879 ],
6880 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
6881 # applicable when performing per-zone operations.
6882 }</pre>
6883 </div>
6884
6885 <div class="method">
6886 <code class="details" id="startAsyncReplication">startAsyncReplication(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
6887 <pre>Starts asynchronous replication.
6888 Must be invoked on the primary disk.
6889
6890 Args:
6891 project: string, Project ID for this request. (required)
6892 zone: string, The name of the zone for this request. (required)
6893 disk: string, The name of the persistent disk. (required)
6894 body: object, The request body.
6895 The object takes the form of:
6896
6897 {
6898 &quot;asyncSecondaryDisk&quot;: &quot;A String&quot;, # The secondary disk to start asynchronous replication to.
6899 # You can provide this as a partial or full URL to the resource. For example,
6900 # the following are valid values:
6901 #
6902 #
6903 # -
6904 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
6905 #
6906 # -
6907 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
6908 #
6909 # -
6910 # projects/project/zones/zone/disks/disk
6911 #
6912 # -
6913 # projects/project/regions/region/disks/disk
6914 #
6915 # -
6916 # zones/zone/disks/disk
6917 #
6918 # -
6919 # regions/region/disks/disk
6920 }
6921
6922 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
6923 that if you must retry your request, the server will know to ignore the
6924 request if it has already been completed.
6925
6926 For example, consider a situation where you make an initial request and
6927 the request times out. If you make the request again with the same
6928 request ID, the server can check if original operation with the same
6929 request ID was received, and if so, will ignore the second request. This
6930 prevents clients from accidentally creating duplicate commitments.
6931
6932 The request ID must be
6933 a valid UUID with the exception that zero UUID is not supported
6934 (00000000-0000-0000-0000-000000000000).
6935 x__xgafv: string, V1 error format.
6936 Allowed values
6937 1 - v1 error format
6938 2 - v2 error format
6939
6940 Returns:
6941 An object of the form:
6942
6943 { # Represents an Operation resource.
6944 #
6945 # Google Compute Engine has three Operation resources:
6946 #
6947 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
6948 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
6949 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
6950 #
6951 # You can use an operation resource to manage asynchronous API requests.
6952 # For more information, readHandling
6953 # API responses.
6954 #
6955 # Operations can be global, regional or zonal.
6956 #
6957 # - For global operations, use the `globalOperations`
6958 # resource.
6959 # - For regional operations, use the
6960 # `regionOperations` resource.
6961 # - For zonal operations, use
6962 # the `zoneOperations` resource.
6963 #
6964 #
6965 #
6966 # For more information, read
6967 # Global, Regional, and Zonal Resources.
6968 #
6969 # Note that completed Operation resources have a limited
6970 # retention period.
6971 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
6972 # Not present otherwise.
6973 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
6974 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
6975 # set when the operation is created.
6976 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
6977 # text format.
6978 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
6979 # this field will be populated.
6980 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
6981 # operation.
6982 {
6983 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
6984 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
6985 # details. There is a set of defined message types to use for providing
6986 # details.The syntax depends on the error code. For example,
6987 # QuotaExceededInfo will have details when the error code is
6988 # QUOTA_EXCEEDED.
6989 {
6990 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
6991 #
6992 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
6993 # is not enabled:
6994 #
6995 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
6996 # &quot;domain&quot;: &quot;googleapis.com&quot;
6997 # &quot;metadata&quot;: {
6998 # &quot;resource&quot;: &quot;projects/123&quot;,
6999 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7000 # }
7001 # }
7002 #
7003 # This response indicates that the pubsub.googleapis.com API is not enabled.
7004 #
7005 # Example of an error that is returned when attempting to create a Spanner
7006 # instance in a region that is out of stock:
7007 #
7008 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7009 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7010 # &quot;metadata&quot;: {
7011 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7012 # }
7013 # }
7014 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7015 # is typically the registered service name of the tool or product that
7016 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7017 # generated by some common infrastructure, the error domain must be a
7018 # globally unique value that identifies the infrastructure. For Google API
7019 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7020 &quot;metadatas&quot;: { # Additional structured details about this error.
7021 #
7022 # Keys must match a regular expression of `a-z+` but should
7023 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7024 # length. When identifying the current value of an exceeded limit, the units
7025 # should be contained in the key, not the value. For example, rather than
7026 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7027 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7028 # instances that can be created in a single (batch) request.
7029 &quot;a_key&quot;: &quot;A String&quot;,
7030 },
7031 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7032 # proximate cause of the error. Error reasons are unique within a particular
7033 # domain of errors. This should be at most 63 characters and match a
7034 # regular expression of `A-Z+[A-Z0-9]`, which represents
7035 # UPPER_SNAKE_CASE.
7036 },
7037 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7038 #
7039 # For example, if a quota check failed with an error indicating the calling
7040 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7041 # directly to the right place in the developer console to flip the bit.
7042 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7043 { # Describes a URL link.
7044 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7045 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7046 },
7047 ],
7048 },
7049 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7050 # which can be attached to an RPC error.
7051 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7052 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7053 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7054 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7055 },
7056 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7057 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7058 &quot;a_key&quot;: &quot;A String&quot;,
7059 },
7060 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7061 # type or metric.
7062 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7063 # or metric.
7064 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7065 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7066 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7067 },
7068 },
7069 ],
7070 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7071 # This property is optional.
7072 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7073 },
7074 ],
7075 },
7076 &quot;getVersionOperationMetadata&quot;: {
7077 &quot;inlineSbomInfo&quot;: {
7078 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7079 # appropriate identifiers.
7080 &quot;a_key&quot;: &quot;A String&quot;,
7081 },
7082 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7083 # identifiers.
7084 &quot;a_key&quot;: &quot;A String&quot;,
7085 },
7086 },
7087 },
7088 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7089 # message that was returned, such as `NOT FOUND`.
7090 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7091 # status code that was returned. For example, a `404` means the
7092 # resource was not found.
7093 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7094 # defined by the server.
7095 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7096 # This value is inRFC3339
7097 # text format.
7098 &quot;instancesBulkInsertOperationMetadata&quot;: {
7099 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7100 # Example key: zones/us-central1-a
7101 &quot;a_key&quot;: {
7102 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7103 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7104 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7105 # error.
7106 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7107 # if the flow is rolling forward or rolling back.
7108 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7109 },
7110 },
7111 },
7112 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7113 # Operation resources.
7114 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7115 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7116 # group of operations results from a `bulkInsert` API request.
7117 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7118 # `update`, or `delete`, and so on.
7119 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7120 # There is no requirement that this be linear or support any granularity of
7121 # operations. This should not be used to guess when the operation will be
7122 # complete. This number should monotonically increase as the operation
7123 # progresses.
7124 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7125 # applicable when performing regional operations.
7126 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7127 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7128 # this field will contain information on all underlying zonal actions and
7129 # their state.
7130 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7131 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7132 # Example key: zones/us-central1-a
7133 &quot;a_key&quot;: {
7134 &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
7135 # populated.
7136 # different programming environments, including REST APIs and RPC APIs. It is
7137 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7138 # three pieces of data: error code, error message, and error details.
7139 #
7140 # You can find out more about this error model and how to work with it in the
7141 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7142 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7143 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7144 # message types for APIs to use.
7145 {
7146 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7147 },
7148 ],
7149 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7150 # user-facing error message should be localized and sent in the
7151 # google.rpc.Status.details field, or localized by the client.
7152 },
7153 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7154 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7155 },
7156 },
7157 },
7158 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7159 # This value is inRFC3339
7160 # text format.
7161 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7162 # following:
7163 # `PENDING`, `RUNNING`, or `DONE`.
7164 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7165 # operation.
7166 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7167 # of the target resource.
7168 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7169 # operations related to creating a snapshot, this points to the disk
7170 # that the snapshot was created from.
7171 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7172 # `[email protected]` or
7173 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7174 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7175 # operation, this field will be populated.
7176 {
7177 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7178 # Engine returns NO_RESULTS_ON_PAGE if there
7179 # are no results in the response.
7180 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7181 # value format. For example:
7182 #
7183 # &quot;data&quot;: [
7184 # {
7185 # &quot;key&quot;: &quot;scope&quot;,
7186 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7187 # }
7188 {
7189 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7190 # returned. For example, for warnings where there are no results in a list
7191 # request for a particular zone, this key might be scope and
7192 # the key value might be the zone name. Other examples might be a key
7193 # indicating a deprecated resource and a suggested replacement, or a
7194 # warning about invalid network settings (for example, if an instance
7195 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7196 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7197 },
7198 ],
7199 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7200 },
7201 ],
7202 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7203 # applicable when performing per-zone operations.
7204 }</pre>
7205 </div>
7206
7207 <div class="method">
7208 <code class="details" id="stopAsyncReplication">stopAsyncReplication(project, zone, disk, requestId=None, x__xgafv=None)</code>
7209 <pre>Stops asynchronous replication.
7210 Can be invoked either on the primary or on the secondary disk.
7211
7212 Args:
7213 project: string, Project ID for this request. (required)
7214 zone: string, The name of the zone for this request. (required)
7215 disk: string, The name of the persistent disk. (required)
7216 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7217 that if you must retry your request, the server will know to ignore the
7218 request if it has already been completed.
7219
7220 For example, consider a situation where you make an initial request and
7221 the request times out. If you make the request again with the same
7222 request ID, the server can check if original operation with the same
7223 request ID was received, and if so, will ignore the second request. This
7224 prevents clients from accidentally creating duplicate commitments.
7225
7226 The request ID must be
7227 a valid UUID with the exception that zero UUID is not supported
7228 (00000000-0000-0000-0000-000000000000).
7229 x__xgafv: string, V1 error format.
7230 Allowed values
7231 1 - v1 error format
7232 2 - v2 error format
7233
7234 Returns:
7235 An object of the form:
7236
7237 { # Represents an Operation resource.
7238 #
7239 # Google Compute Engine has three Operation resources:
7240 #
7241 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7242 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7243 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7244 #
7245 # You can use an operation resource to manage asynchronous API requests.
7246 # For more information, readHandling
7247 # API responses.
7248 #
7249 # Operations can be global, regional or zonal.
7250 #
7251 # - For global operations, use the `globalOperations`
7252 # resource.
7253 # - For regional operations, use the
7254 # `regionOperations` resource.
7255 # - For zonal operations, use
7256 # the `zoneOperations` resource.
7257 #
7258 #
7259 #
7260 # For more information, read
7261 # Global, Regional, and Zonal Resources.
7262 #
7263 # Note that completed Operation resources have a limited
7264 # retention period.
7265 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7266 # Not present otherwise.
7267 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7268 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7269 # set when the operation is created.
7270 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7271 # text format.
7272 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7273 # this field will be populated.
7274 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7275 # operation.
7276 {
7277 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7278 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7279 # details. There is a set of defined message types to use for providing
7280 # details.The syntax depends on the error code. For example,
7281 # QuotaExceededInfo will have details when the error code is
7282 # QUOTA_EXCEEDED.
7283 {
7284 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7285 #
7286 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7287 # is not enabled:
7288 #
7289 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7290 # &quot;domain&quot;: &quot;googleapis.com&quot;
7291 # &quot;metadata&quot;: {
7292 # &quot;resource&quot;: &quot;projects/123&quot;,
7293 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7294 # }
7295 # }
7296 #
7297 # This response indicates that the pubsub.googleapis.com API is not enabled.
7298 #
7299 # Example of an error that is returned when attempting to create a Spanner
7300 # instance in a region that is out of stock:
7301 #
7302 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7303 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7304 # &quot;metadata&quot;: {
7305 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7306 # }
7307 # }
7308 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7309 # is typically the registered service name of the tool or product that
7310 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7311 # generated by some common infrastructure, the error domain must be a
7312 # globally unique value that identifies the infrastructure. For Google API
7313 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7314 &quot;metadatas&quot;: { # Additional structured details about this error.
7315 #
7316 # Keys must match a regular expression of `a-z+` but should
7317 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7318 # length. When identifying the current value of an exceeded limit, the units
7319 # should be contained in the key, not the value. For example, rather than
7320 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7321 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7322 # instances that can be created in a single (batch) request.
7323 &quot;a_key&quot;: &quot;A String&quot;,
7324 },
7325 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7326 # proximate cause of the error. Error reasons are unique within a particular
7327 # domain of errors. This should be at most 63 characters and match a
7328 # regular expression of `A-Z+[A-Z0-9]`, which represents
7329 # UPPER_SNAKE_CASE.
7330 },
7331 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7332 #
7333 # For example, if a quota check failed with an error indicating the calling
7334 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7335 # directly to the right place in the developer console to flip the bit.
7336 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7337 { # Describes a URL link.
7338 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7339 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7340 },
7341 ],
7342 },
7343 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7344 # which can be attached to an RPC error.
7345 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7346 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7347 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7348 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7349 },
7350 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7351 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7352 &quot;a_key&quot;: &quot;A String&quot;,
7353 },
7354 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7355 # type or metric.
7356 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7357 # or metric.
7358 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7359 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7360 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7361 },
7362 },
7363 ],
7364 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7365 # This property is optional.
7366 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7367 },
7368 ],
7369 },
7370 &quot;getVersionOperationMetadata&quot;: {
7371 &quot;inlineSbomInfo&quot;: {
7372 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7373 # appropriate identifiers.
7374 &quot;a_key&quot;: &quot;A String&quot;,
7375 },
7376 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7377 # identifiers.
7378 &quot;a_key&quot;: &quot;A String&quot;,
7379 },
7380 },
7381 },
7382 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7383 # message that was returned, such as `NOT FOUND`.
7384 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7385 # status code that was returned. For example, a `404` means the
7386 # resource was not found.
7387 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7388 # defined by the server.
7389 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7390 # This value is inRFC3339
7391 # text format.
7392 &quot;instancesBulkInsertOperationMetadata&quot;: {
7393 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7394 # Example key: zones/us-central1-a
7395 &quot;a_key&quot;: {
7396 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7397 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7398 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7399 # error.
7400 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7401 # if the flow is rolling forward or rolling back.
7402 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7403 },
7404 },
7405 },
7406 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7407 # Operation resources.
7408 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7409 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7410 # group of operations results from a `bulkInsert` API request.
7411 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7412 # `update`, or `delete`, and so on.
7413 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7414 # There is no requirement that this be linear or support any granularity of
7415 # operations. This should not be used to guess when the operation will be
7416 # complete. This number should monotonically increase as the operation
7417 # progresses.
7418 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7419 # applicable when performing regional operations.
7420 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7421 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7422 # this field will contain information on all underlying zonal actions and
7423 # their state.
7424 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7425 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7426 # Example key: zones/us-central1-a
7427 &quot;a_key&quot;: {
7428 &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
7429 # populated.
7430 # different programming environments, including REST APIs and RPC APIs. It is
7431 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7432 # three pieces of data: error code, error message, and error details.
7433 #
7434 # You can find out more about this error model and how to work with it in the
7435 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7436 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7437 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7438 # message types for APIs to use.
7439 {
7440 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7441 },
7442 ],
7443 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7444 # user-facing error message should be localized and sent in the
7445 # google.rpc.Status.details field, or localized by the client.
7446 },
7447 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7448 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7449 },
7450 },
7451 },
7452 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7453 # This value is inRFC3339
7454 # text format.
7455 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7456 # following:
7457 # `PENDING`, `RUNNING`, or `DONE`.
7458 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7459 # operation.
7460 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7461 # of the target resource.
7462 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7463 # operations related to creating a snapshot, this points to the disk
7464 # that the snapshot was created from.
7465 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7466 # `[email protected]` or
7467 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7468 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7469 # operation, this field will be populated.
7470 {
7471 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7472 # Engine returns NO_RESULTS_ON_PAGE if there
7473 # are no results in the response.
7474 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7475 # value format. For example:
7476 #
7477 # &quot;data&quot;: [
7478 # {
7479 # &quot;key&quot;: &quot;scope&quot;,
7480 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7481 # }
7482 {
7483 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7484 # returned. For example, for warnings where there are no results in a list
7485 # request for a particular zone, this key might be scope and
7486 # the key value might be the zone name. Other examples might be a key
7487 # indicating a deprecated resource and a suggested replacement, or a
7488 # warning about invalid network settings (for example, if an instance
7489 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7490 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7491 },
7492 ],
7493 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7494 },
7495 ],
7496 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7497 # applicable when performing per-zone operations.
7498 }</pre>
7499 </div>
7500
7501 <div class="method">
7502 <code class="details" id="stopGroupAsyncReplication">stopGroupAsyncReplication(project, zone, body=None, requestId=None, x__xgafv=None)</code>
7503 <pre>Stops asynchronous replication for a consistency group of disks.
7504 Can be invoked either in the primary or secondary scope.
7505
7506 Args:
7507 project: string, Project ID for this request. (required)
7508 zone: string, The name of the zone for this request. This must be the zone of the primary
7509 or secondary disks in the consistency group. (required)
7510 body: object, The request body.
7511 The object takes the form of:
7512
7513 { # A transient resource used in compute.disks.stopGroupAsyncReplication and
7514 # compute.regionDisks.stopGroupAsyncReplication. It is only used to process
7515 # requests and is not persisted.
7516 &quot;resourcePolicy&quot;: &quot;A String&quot;, # The URL of the DiskConsistencyGroupPolicy for the group of disks to stop.
7517 # This may be a full or partial URL, such as:
7518 #
7519 #
7520 # -
7521 # https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy
7522 #
7523 # -
7524 # projects/project/regions/region/resourcePolicies/resourcePolicy
7525 #
7526 # -
7527 # regions/region/resourcePolicies/resourcePolicy
7528 }
7529
7530 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
7531 that if you must retry your request, the server will know to ignore the
7532 request if it has already been completed.
7533
7534 For example, consider a situation where you make an initial request and
7535 the request times out. If you make the request again with the same
7536 request ID, the server can check if original operation with the same
7537 request ID was received, and if so, will ignore the second request. This
7538 prevents clients from accidentally creating duplicate commitments.
7539
7540 The request ID must be
7541 a valid UUID with the exception that zero UUID is not supported
7542 (00000000-0000-0000-0000-000000000000).
7543 x__xgafv: string, V1 error format.
7544 Allowed values
7545 1 - v1 error format
7546 2 - v2 error format
7547
7548 Returns:
7549 An object of the form:
7550
7551 { # Represents an Operation resource.
7552 #
7553 # Google Compute Engine has three Operation resources:
7554 #
7555 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
7556 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
7557 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
7558 #
7559 # You can use an operation resource to manage asynchronous API requests.
7560 # For more information, readHandling
7561 # API responses.
7562 #
7563 # Operations can be global, regional or zonal.
7564 #
7565 # - For global operations, use the `globalOperations`
7566 # resource.
7567 # - For regional operations, use the
7568 # `regionOperations` resource.
7569 # - For zonal operations, use
7570 # the `zoneOperations` resource.
7571 #
7572 #
7573 #
7574 # For more information, read
7575 # Global, Regional, and Zonal Resources.
7576 #
7577 # Note that completed Operation resources have a limited
7578 # retention period.
7579 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
7580 # Not present otherwise.
7581 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
7582 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
7583 # set when the operation is created.
7584 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
7585 # text format.
7586 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
7587 # this field will be populated.
7588 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
7589 # operation.
7590 {
7591 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
7592 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
7593 # details. There is a set of defined message types to use for providing
7594 # details.The syntax depends on the error code. For example,
7595 # QuotaExceededInfo will have details when the error code is
7596 # QUOTA_EXCEEDED.
7597 {
7598 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
7599 #
7600 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
7601 # is not enabled:
7602 #
7603 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
7604 # &quot;domain&quot;: &quot;googleapis.com&quot;
7605 # &quot;metadata&quot;: {
7606 # &quot;resource&quot;: &quot;projects/123&quot;,
7607 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
7608 # }
7609 # }
7610 #
7611 # This response indicates that the pubsub.googleapis.com API is not enabled.
7612 #
7613 # Example of an error that is returned when attempting to create a Spanner
7614 # instance in a region that is out of stock:
7615 #
7616 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
7617 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
7618 # &quot;metadata&quot;: {
7619 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
7620 # }
7621 # }
7622 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
7623 # is typically the registered service name of the tool or product that
7624 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
7625 # generated by some common infrastructure, the error domain must be a
7626 # globally unique value that identifies the infrastructure. For Google API
7627 # infrastructure, the error domain is &quot;googleapis.com&quot;.
7628 &quot;metadatas&quot;: { # Additional structured details about this error.
7629 #
7630 # Keys must match a regular expression of `a-z+` but should
7631 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
7632 # length. When identifying the current value of an exceeded limit, the units
7633 # should be contained in the key, not the value. For example, rather than
7634 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
7635 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
7636 # instances that can be created in a single (batch) request.
7637 &quot;a_key&quot;: &quot;A String&quot;,
7638 },
7639 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
7640 # proximate cause of the error. Error reasons are unique within a particular
7641 # domain of errors. This should be at most 63 characters and match a
7642 # regular expression of `A-Z+[A-Z0-9]`, which represents
7643 # UPPER_SNAKE_CASE.
7644 },
7645 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
7646 #
7647 # For example, if a quota check failed with an error indicating the calling
7648 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
7649 # directly to the right place in the developer console to flip the bit.
7650 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
7651 { # Describes a URL link.
7652 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
7653 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
7654 },
7655 ],
7656 },
7657 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
7658 # which can be attached to an RPC error.
7659 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
7660 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
7661 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
7662 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
7663 },
7664 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
7665 &quot;dimensions&quot;: { # The map holding related quota dimensions.
7666 &quot;a_key&quot;: &quot;A String&quot;,
7667 },
7668 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
7669 # type or metric.
7670 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
7671 # or metric.
7672 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
7673 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
7674 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
7675 },
7676 },
7677 ],
7678 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
7679 # This property is optional.
7680 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
7681 },
7682 ],
7683 },
7684 &quot;getVersionOperationMetadata&quot;: {
7685 &quot;inlineSbomInfo&quot;: {
7686 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
7687 # appropriate identifiers.
7688 &quot;a_key&quot;: &quot;A String&quot;,
7689 },
7690 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
7691 # identifiers.
7692 &quot;a_key&quot;: &quot;A String&quot;,
7693 },
7694 },
7695 },
7696 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
7697 # message that was returned, such as `NOT FOUND`.
7698 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
7699 # status code that was returned. For example, a `404` means the
7700 # resource was not found.
7701 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
7702 # defined by the server.
7703 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
7704 # This value is inRFC3339
7705 # text format.
7706 &quot;instancesBulkInsertOperationMetadata&quot;: {
7707 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
7708 # Example key: zones/us-central1-a
7709 &quot;a_key&quot;: {
7710 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
7711 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
7712 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
7713 # error.
7714 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
7715 # if the flow is rolling forward or rolling back.
7716 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
7717 },
7718 },
7719 },
7720 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
7721 # Operation resources.
7722 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
7723 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
7724 # group of operations results from a `bulkInsert` API request.
7725 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
7726 # `update`, or `delete`, and so on.
7727 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
7728 # There is no requirement that this be linear or support any granularity of
7729 # operations. This should not be used to guess when the operation will be
7730 # complete. This number should monotonically increase as the operation
7731 # progresses.
7732 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
7733 # applicable when performing regional operations.
7734 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
7735 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
7736 # this field will contain information on all underlying zonal actions and
7737 # their state.
7738 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
7739 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
7740 # Example key: zones/us-central1-a
7741 &quot;a_key&quot;: {
7742 &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
7743 # populated.
7744 # different programming environments, including REST APIs and RPC APIs. It is
7745 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
7746 # three pieces of data: error code, error message, and error details.
7747 #
7748 # You can find out more about this error model and how to work with it in the
7749 # [API Design Guide](https://cloud.google.com/apis/design/errors).
7750 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
7751 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
7752 # message types for APIs to use.
7753 {
7754 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
7755 },
7756 ],
7757 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
7758 # user-facing error message should be localized and sent in the
7759 # google.rpc.Status.details field, or localized by the client.
7760 },
7761 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
7762 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
7763 },
7764 },
7765 },
7766 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
7767 # This value is inRFC3339
7768 # text format.
7769 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
7770 # following:
7771 # `PENDING`, `RUNNING`, or `DONE`.
7772 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
7773 # operation.
7774 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
7775 # of the target resource.
7776 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
7777 # operations related to creating a snapshot, this points to the disk
7778 # that the snapshot was created from.
7779 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
7780 # `[email protected]` or
7781 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
7782 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
7783 # operation, this field will be populated.
7784 {
7785 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
7786 # Engine returns NO_RESULTS_ON_PAGE if there
7787 # are no results in the response.
7788 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
7789 # value format. For example:
7790 #
7791 # &quot;data&quot;: [
7792 # {
7793 # &quot;key&quot;: &quot;scope&quot;,
7794 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
7795 # }
7796 {
7797 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
7798 # returned. For example, for warnings where there are no results in a list
7799 # request for a particular zone, this key might be scope and
7800 # the key value might be the zone name. Other examples might be a key
7801 # indicating a deprecated resource and a suggested replacement, or a
7802 # warning about invalid network settings (for example, if an instance
7803 # attempts to perform IP forwarding but is not enabled for IP forwarding).
7804 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
7805 },
7806 ],
7807 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
7808 },
7809 ],
7810 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
7811 # applicable when performing per-zone operations.
7812 }</pre>
7813 </div>
7814
7815 <div class="method">
7816 <code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None, x__xgafv=None)</code>
7817 <pre>Returns permissions that a caller has on the specified resource.
7818
7819 Args:
7820 project: string, Project ID for this request. (required)
7821 zone: string, The name of the zone for this request. (required)
7822 resource: string, Name or id of the resource for this request. (required)
7823 body: object, The request body.
7824 The object takes the form of:
7825
7826 {
7827 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
7828 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
7829 &quot;A String&quot;,
7830 ],
7831 }
7832
7833 x__xgafv: string, V1 error format.
7834 Allowed values
7835 1 - v1 error format
7836 2 - v2 error format
7837
7838 Returns:
7839 An object of the form:
7840
7841 {
7842 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
7843 # allowed.
7844 &quot;A String&quot;,
7845 ],
7846 }</pre>
7847 </div>
7848
7849 <div class="method">
7850 <code class="details" id="update">update(project, zone, disk, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code>
7851 <pre>Updates the specified disk with the data included in the request.
7852 The update is performed only on selected fields included as part
7853 of update-mask.
7854
7855 Args:
7856 project: string, Project ID for this request. (required)
7857 zone: string, The name of the zone for this request. (required)
7858 disk: string, The disk name for this request. (required)
7859 body: object, The request body.
7860 The object takes the form of:
7861
7862 { # Represents a Persistent Disk resource.
7863 #
7864 # Google Compute Engine has two Disk resources:
7865 #
7866 # * [Zonal](/compute/docs/reference/rest/v1/disks)
7867 # * [Regional](/compute/docs/reference/rest/v1/regionDisks)
7868 #
7869 # Persistent disks are required for running your VM instances.
7870 # Create both boot and non-boot (data) persistent disks. For more information,
7871 # read Persistent Disks. For more
7872 # storage options, read Storage options.
7873 #
7874 # The disks resource represents a zonal persistent disk.
7875 # For more information, readZonal persistent disks.
7876 #
7877 # The regionDisks resource represents a
7878 # regional persistent disk. For more information, read
7879 # Regional resources.
7880 &quot;accessMode&quot;: &quot;A String&quot;, # The access mode of the disk.
7881 #
7882 #
7883 # - READ_WRITE_SINGLE: The default AccessMode, means the
7884 # disk can be attached to single instance in RW mode.
7885 # - READ_WRITE_MANY: The AccessMode means the disk can be
7886 # attached to multiple instances in RW mode.
7887 # - READ_ONLY_MANY: The AccessMode means the disk can be
7888 # attached to multiple instances in RO mode.
7889 #
7890 #
7891 # The AccessMode is only valid for Hyperdisk disk types.
7892 &quot;architecture&quot;: &quot;A String&quot;, # The architecture of the disk. Valid values are
7893 # ARM64 or X86_64.
7894 &quot;asyncPrimaryDisk&quot;: { # Disk asynchronously replicated into this disk.
7895 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
7896 # started on the disk as a member of a group.
7897 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
7898 # started on the disk as a member of a group.
7899 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
7900 # You can provide this as a partial or full URL to the resource.
7901 # For example, the following are valid values:
7902 #
7903 #
7904 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
7905 # - projects/project/zones/zone/disks/disk
7906 # - zones/zone/disks/disk
7907 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
7908 # to or from the current disk. This value identifies the exact disk that
7909 # was used to create this replication. For example, if you started
7910 # replicating the persistent disk from a disk that was later deleted and
7911 # recreated under the same name, the disk ID would identify the exact
7912 # version of the disk that was used.
7913 },
7914 &quot;asyncSecondaryDisks&quot;: { # Output only. [Output Only] A list of disks this disk is asynchronously replicated to.
7915 &quot;a_key&quot;: {
7916 &quot;asyncReplicationDisk&quot;: {
7917 &quot;consistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was
7918 # started on the disk as a member of a group.
7919 &quot;consistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was
7920 # started on the disk as a member of a group.
7921 &quot;disk&quot;: &quot;A String&quot;, # The other disk asynchronously replicated to or from the current disk.
7922 # You can provide this as a partial or full URL to the resource.
7923 # For example, the following are valid values:
7924 #
7925 #
7926 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
7927 # - projects/project/zones/zone/disks/disk
7928 # - zones/zone/disks/disk
7929 &quot;diskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the other disk asynchronously replicated
7930 # to or from the current disk. This value identifies the exact disk that
7931 # was used to create this replication. For example, if you started
7932 # replicating the persistent disk from a disk that was later deleted and
7933 # recreated under the same name, the disk ID would identify the exact
7934 # version of the disk that was used.
7935 },
7936 },
7937 },
7938 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
7939 # text format.
7940 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
7941 # create the resource.
7942 &quot;diskEncryptionKey&quot;: { # Encrypts the disk using a
7943 # customer-supplied encryption key or a
7944 # customer-managed encryption key.
7945 #
7946 # Encryption keys do not protect access to metadata of the disk.
7947 #
7948 # After you encrypt a disk with a customer-supplied key, you must provide the
7949 # same key if you use the disk later. For example, to create a disk snapshot,
7950 # to create a disk image, to create a machine image, or to attach the disk to
7951 # a virtual machine.
7952 #
7953 # After you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*
7954 # name once the disk is created. The disk is encrypted with this version of
7955 # the key. In the response, diskEncryptionKey.kmsKeyName appears
7956 # in the following format:
7957 #
7958 # &quot;diskEncryptionKey.kmsKeyName&quot;:
7959 # &quot;projects/kms_project_id/locations/region/keyRings/
7960 # key_region/cryptoKeys/key
7961 # /cryptoKeysVersions/version
7962 #
7963 # If you do not provide an encryption key when creating the disk, then the
7964 # disk is encrypted using an automatically generated key and you don&#x27;t need
7965 # to provide a key to use the disk later.
7966 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
7967 # For example:
7968 #
7969 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7970 # key_region/cryptoKeys/key
7971 #
7972 # The fully-qualifed key name may be returned for resource GET requests. For
7973 # example:
7974 #
7975 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
7976 # key_region/cryptoKeys/key
7977 # /cryptoKeyVersions/1
7978 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
7979 # key. If absent, the Compute Engine default service account is used.
7980 # For example:
7981 #
7982 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
7983 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
7984 # encryption key, encoded in RFC
7985 # 4648 base64 to either encrypt or decrypt this resource. You can
7986 # provide either the rawKey or thersaEncryptedKey.
7987 # For example:
7988 #
7989 # &quot;rawKey&quot;:
7990 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
7991 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
7992 # customer-supplied encryption key to either encrypt or decrypt this
7993 # resource. You can provide either the rawKey or thersaEncryptedKey.
7994 # For example:
7995 #
7996 # &quot;rsaEncryptedKey&quot;:
7997 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
7998 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
7999 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8000 #
8001 # The key must meet the following requirements before you can provide it to
8002 # Compute Engine:
8003 #
8004 # 1. The key is wrapped using a RSA public key certificate provided by
8005 # Google.
8006 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8007 # encoding.
8008 #
8009 # Gets the RSA public key certificate provided by Google at:
8010 #
8011 #
8012 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8013 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8014 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8015 # encryption key that protects this resource.
8016 },
8017 &quot;enableConfidentialCompute&quot;: True or False, # Whether this disk is using confidential compute mode.
8018 &quot;guestOsFeatures&quot;: [ # A list of features to enable on the guest operating system. Applicable
8019 # only for bootable images. Read
8020 # Enabling guest operating system features to see a list of available
8021 # options.
8022 { # Guest OS features.
8023 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
8024 # separate values. Set to one or more of the following values:
8025 #
8026 # - VIRTIO_SCSI_MULTIQUEUE
8027 # - WINDOWS
8028 # - MULTI_IP_SUBNET
8029 # - UEFI_COMPATIBLE
8030 # - GVNIC
8031 # - SEV_CAPABLE
8032 # - SUSPEND_RESUME_COMPATIBLE
8033 # - SEV_LIVE_MIGRATABLE_V2
8034 # - SEV_SNP_CAPABLE
8035 # - TDX_CAPABLE
8036 # - IDPF
8037 # - SNP_SVSM_CAPABLE
8038 # - CCA_CAPABLE
8039 #
8040 #
8041 # For more information, see
8042 # Enabling guest operating system features.
8043 },
8044 ],
8045 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
8046 # defined by the server.
8047 &quot;kind&quot;: &quot;compute#disk&quot;, # Output only. [Output Only] Type of the resource. Always compute#disk for
8048 # disks.
8049 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this disk, which is
8050 # essentially a hash of the labels set used for optimistic locking. The
8051 # fingerprint is initially generated by Compute Engine and changes after
8052 # every request to modify or update labels. You must always provide an
8053 # up-to-date fingerprint hash in order to update or change labels,
8054 # otherwise the request will fail with error412 conditionNotMet.
8055 #
8056 # To see the latest fingerprint, make a get() request to
8057 # retrieve a disk.
8058 &quot;labels&quot;: { # Labels to apply to this disk. These can be later modified by
8059 # the setLabels method.
8060 &quot;a_key&quot;: &quot;A String&quot;,
8061 },
8062 &quot;lastAttachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last attach timestamp inRFC3339
8063 # text format.
8064 &quot;lastDetachTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Last detach timestamp inRFC3339
8065 # text format.
8066 &quot;licenseCodes&quot;: [ # Integer license codes indicating which licenses are attached to this disk.
8067 &quot;A String&quot;,
8068 ],
8069 &quot;licenses&quot;: [ # A list of publicly visible licenses. Reserved for Google&#x27;s use.
8070 &quot;A String&quot;,
8071 ],
8072 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the disk close to other resources.
8073 # This field is for use by internal tools that use the public API.
8074 &quot;name&quot;: &quot;A String&quot;, # Name of the resource. Provided by the client when the resource is created.
8075 # The name must be 1-63 characters long, and comply withRFC1035.
8076 # Specifically, the name must be 1-63 characters long and match the regular
8077 # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
8078 # which means the first character must be a lowercase letter, and all
8079 # following characters must be a dash, lowercase letter, or digit, except
8080 # the last character, which cannot be a dash.
8081 &quot;options&quot;: &quot;A String&quot;, # Internal use only.
8082 &quot;params&quot;: { # Additional disk params. # Input only. [Input Only] Additional params passed with the request, but not persisted
8083 # as part of resource payload.
8084 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the disk. Tag keys and values
8085 # have the same definition as resource
8086 # manager tags. Keys and values can be either in numeric format,
8087 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
8088 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
8089 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
8090 # PATCH) when empty.
8091 &quot;a_key&quot;: &quot;A String&quot;,
8092 },
8093 },
8094 &quot;physicalBlockSizeBytes&quot;: &quot;A String&quot;, # Physical block size of the persistent disk, in bytes.
8095 # If not present in a request, a default value is used.
8096 # The currently supported size is 4096, other sizes may be added in
8097 # the future.
8098 # If an unsupported value is requested, the error message will list
8099 # the supported values for the caller&#x27;s project.
8100 &quot;provisionedIops&quot;: &quot;A String&quot;, # Indicates how many IOPS to provision for the disk. This sets the number
8101 # of I/O operations per second that the disk can handle. Values must be
8102 # between 10,000 and 120,000. For more details, see theExtreme persistent
8103 # disk documentation.
8104 &quot;provisionedThroughput&quot;: &quot;A String&quot;, # Indicates how much throughput to provision for the disk. This sets the
8105 # number of throughput mb per second that the disk can handle. Values must be
8106 # greater than or equal to 1.
8107 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the disk resides. Only applicable for
8108 # regional resources.
8109 # You must specify this field as part of the HTTP request URL. It is
8110 # not settable as a field in the request body.
8111 &quot;replicaZones&quot;: [ # URLs of the zones where the disk should be replicated to. Only applicable
8112 # for regional resources.
8113 &quot;A String&quot;,
8114 ],
8115 &quot;resourcePolicies&quot;: [ # Resource policies applied to this disk for automatic snapshot creations.
8116 &quot;A String&quot;,
8117 ],
8118 &quot;resourceStatus&quot;: { # Output only. [Output Only] Status information for the disk resource.
8119 &quot;asyncPrimaryDisk&quot;: {
8120 &quot;state&quot;: &quot;A String&quot;,
8121 },
8122 &quot;asyncSecondaryDisks&quot;: { # Key: disk, value: AsyncReplicationStatus message
8123 &quot;a_key&quot;: {
8124 &quot;state&quot;: &quot;A String&quot;,
8125 },
8126 },
8127 },
8128 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
8129 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
8130 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
8131 &quot;sizeGb&quot;: &quot;A String&quot;, # Size, in GB, of the persistent disk. You can specify
8132 # this field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty
8133 # persistent disk.
8134 #
8135 # If you specify this field along with a source, the value ofsizeGb must not be less than the size of the
8136 # source.
8137 # Acceptable values are greater than 0.
8138 &quot;sourceConsistencyGroupPolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk
8139 # that was created using a consistency group.
8140 &quot;sourceConsistencyGroupPolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk
8141 # that was created using a consistency group.
8142 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this disk. You can provide this as a
8143 # partial or full URL to the resource. For example, the following are valid
8144 # values:
8145 #
8146 #
8147 # -
8148 # https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
8149 #
8150 # -
8151 # https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk
8152 #
8153 # -
8154 # projects/project/zones/zone/disks/disk
8155 #
8156 # -
8157 # projects/project/regions/region/disks/disk
8158 #
8159 # -
8160 # zones/zone/disks/disk
8161 #
8162 # -
8163 # regions/region/disks/disk
8164 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the disk used to create this disk. This
8165 # value identifies the exact disk that was used to create this persistent
8166 # disk. For example, if you created the persistent disk from a disk that
8167 # was later deleted and recreated under the same name, the source disk ID
8168 # would identify the exact version of the disk that was used.
8169 &quot;sourceImage&quot;: &quot;A String&quot;, # The source image used to create this disk. If the source image is
8170 # deleted, this field will not be set.
8171 #
8172 # To create a disk with one of the public operating system images, specify
8173 # the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
8174 #
8175 # projects/debian-cloud/global/images/family/debian-9
8176 #
8177 #
8178 # Alternatively, use a specific version of a public operating system image:
8179 #
8180 # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
8181 #
8182 #
8183 # To create a disk with a custom image that you created, specify the
8184 # image name in the following format:
8185 #
8186 # global/images/my-custom-image
8187 #
8188 #
8189 # You can also specify a custom image by its image family, which returns
8190 # the latest version of the image in that family. Replace the image name
8191 # with family/family-name:
8192 #
8193 # global/images/family/my-image-family
8194 &quot;sourceImageEncryptionKey&quot;: { # Thecustomer-supplied
8195 # encryption key of the source image. Required if the source image is
8196 # protected by a customer-supplied encryption key.
8197 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8198 # For example:
8199 #
8200 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8201 # key_region/cryptoKeys/key
8202 #
8203 # The fully-qualifed key name may be returned for resource GET requests. For
8204 # example:
8205 #
8206 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8207 # key_region/cryptoKeys/key
8208 # /cryptoKeyVersions/1
8209 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8210 # key. If absent, the Compute Engine default service account is used.
8211 # For example:
8212 #
8213 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8214 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8215 # encryption key, encoded in RFC
8216 # 4648 base64 to either encrypt or decrypt this resource. You can
8217 # provide either the rawKey or thersaEncryptedKey.
8218 # For example:
8219 #
8220 # &quot;rawKey&quot;:
8221 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8222 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8223 # customer-supplied encryption key to either encrypt or decrypt this
8224 # resource. You can provide either the rawKey or thersaEncryptedKey.
8225 # For example:
8226 #
8227 # &quot;rsaEncryptedKey&quot;:
8228 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8229 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8230 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8231 #
8232 # The key must meet the following requirements before you can provide it to
8233 # Compute Engine:
8234 #
8235 # 1. The key is wrapped using a RSA public key certificate provided by
8236 # Google.
8237 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8238 # encoding.
8239 #
8240 # Gets the RSA public key certificate provided by Google at:
8241 #
8242 #
8243 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8244 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8245 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8246 # encryption key that protects this resource.
8247 },
8248 &quot;sourceImageId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the image used to create this disk. This
8249 # value identifies the exact image that was used to create this persistent
8250 # disk. For example, if you created the persistent disk from an image that
8251 # was later deleted and recreated under the same name, the source image ID
8252 # would identify the exact version of the image that was used.
8253 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this disk. You can provide
8254 # this as a partial or full URL to the resource. For example, the following
8255 # are valid values:
8256 #
8257 #
8258 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
8259 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
8260 # - zones/zone/instantSnapshots/instantSnapshot
8261 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
8262 # disk. This value identifies the exact instant snapshot that was used to
8263 # create this persistent disk. For example, if you created the persistent
8264 # disk from an instant snapshot that was later deleted and recreated under
8265 # the same name, the source instant snapshot ID would identify the exact
8266 # version of the instant snapshot that was used.
8267 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The source snapshot used to create this disk. You can provide this as a
8268 # partial or full URL to the resource. For example, the following are valid
8269 # values:
8270 #
8271 #
8272 # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
8273 # - projects/project/global/snapshots/snapshot
8274 # - global/snapshots/snapshot
8275 &quot;sourceSnapshotEncryptionKey&quot;: { # Thecustomer-supplied
8276 # encryption key of the source snapshot. Required if the source snapshot
8277 # is protected by a customer-supplied encryption key.
8278 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
8279 # For example:
8280 #
8281 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8282 # key_region/cryptoKeys/key
8283 #
8284 # The fully-qualifed key name may be returned for resource GET requests. For
8285 # example:
8286 #
8287 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
8288 # key_region/cryptoKeys/key
8289 # /cryptoKeyVersions/1
8290 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
8291 # key. If absent, the Compute Engine default service account is used.
8292 # For example:
8293 #
8294 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
8295 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
8296 # encryption key, encoded in RFC
8297 # 4648 base64 to either encrypt or decrypt this resource. You can
8298 # provide either the rawKey or thersaEncryptedKey.
8299 # For example:
8300 #
8301 # &quot;rawKey&quot;:
8302 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
8303 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
8304 # customer-supplied encryption key to either encrypt or decrypt this
8305 # resource. You can provide either the rawKey or thersaEncryptedKey.
8306 # For example:
8307 #
8308 # &quot;rsaEncryptedKey&quot;:
8309 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
8310 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
8311 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
8312 #
8313 # The key must meet the following requirements before you can provide it to
8314 # Compute Engine:
8315 #
8316 # 1. The key is wrapped using a RSA public key certificate provided by
8317 # Google.
8318 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
8319 # encoding.
8320 #
8321 # Gets the RSA public key certificate provided by Google at:
8322 #
8323 #
8324 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
8325 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
8326 # 4648 base64 encoded SHA-256 hash of the customer-supplied
8327 # encryption key that protects this resource.
8328 },
8329 &quot;sourceSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot used to create this disk. This
8330 # value identifies the exact snapshot that was used to create this persistent
8331 # disk. For example, if you created the persistent disk from a snapshot that
8332 # was later deleted and recreated under the same name, the source snapshot ID
8333 # would identify the exact version of the snapshot that was used.
8334 &quot;sourceStorageObject&quot;: &quot;A String&quot;, # The full Google Cloud Storage URI where the disk image is stored. This file
8335 # must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
8336 # machine disk whose name ends in vmdk. Valid URIs may start with gs:// or
8337 # https://storage.googleapis.com/. This flag is not optimized for creating
8338 # multiple disks from a source storage object. To create many disks from a
8339 # source storage object, use gcloud compute images
8340 # import instead.
8341 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of disk creation.
8342 #
8343 #
8344 # - CREATING: Disk is provisioning.
8345 # - RESTORING: Source data is being copied into the
8346 # disk.
8347 # - FAILED: Disk creation failed.
8348 # - READY: Disk is ready for use.
8349 # - DELETING: Disk is deleting.
8350 &quot;storagePool&quot;: &quot;A String&quot;, # The storage pool in which the new disk is created. You can provide
8351 # this as a partial or full URL to the resource. For example, the following
8352 # are valid values:
8353 #
8354 #
8355 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
8356 # - projects/project/zones/zone/storagePools/storagePool
8357 # - zones/zone/storagePools/storagePool
8358 &quot;type&quot;: &quot;A String&quot;, # URL of the disk type resource describing which disk type to use to create
8359 # the disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk
8360 # types.
8361 &quot;users&quot;: [ # Output only. [Output Only] Links to the users of the disk (attached instances)
8362 # in form:projects/project/zones/zone/instances/instance
8363 &quot;A String&quot;,
8364 ],
8365 &quot;zone&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the zone where the disk resides.
8366 # You must specify this field as part of the HTTP request URL. It is
8367 # not settable as a field in the request body.
8368 }
8369
8370 paths: string, A parameter (repeated)
8371 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8372 that if you must retry your request, the server will know to ignore the
8373 request if it has already been completed.
8374
8375 For example, consider a situation where you make an initial request and
8376 the request times out. If you make the request again with the same
8377 request ID, the server can check if original operation with the same
8378 request ID was received, and if so, will ignore the second request. This
8379 prevents clients from accidentally creating duplicate commitments.
8380
8381 The request ID must be
8382 a valid UUID with the exception that zero UUID is not supported
8383 (00000000-0000-0000-0000-000000000000).
8384 updateMask: string, update_mask indicates fields to be updated as part of this request.
8385 x__xgafv: string, V1 error format.
8386 Allowed values
8387 1 - v1 error format
8388 2 - v2 error format
8389
8390 Returns:
8391 An object of the form:
8392
8393 { # Represents an Operation resource.
8394 #
8395 # Google Compute Engine has three Operation resources:
8396 #
8397 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8398 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8399 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8400 #
8401 # You can use an operation resource to manage asynchronous API requests.
8402 # For more information, readHandling
8403 # API responses.
8404 #
8405 # Operations can be global, regional or zonal.
8406 #
8407 # - For global operations, use the `globalOperations`
8408 # resource.
8409 # - For regional operations, use the
8410 # `regionOperations` resource.
8411 # - For zonal operations, use
8412 # the `zoneOperations` resource.
8413 #
8414 #
8415 #
8416 # For more information, read
8417 # Global, Regional, and Zonal Resources.
8418 #
8419 # Note that completed Operation resources have a limited
8420 # retention period.
8421 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8422 # Not present otherwise.
8423 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8424 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8425 # set when the operation is created.
8426 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8427 # text format.
8428 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8429 # this field will be populated.
8430 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8431 # operation.
8432 {
8433 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8434 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8435 # details. There is a set of defined message types to use for providing
8436 # details.The syntax depends on the error code. For example,
8437 # QuotaExceededInfo will have details when the error code is
8438 # QUOTA_EXCEEDED.
8439 {
8440 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8441 #
8442 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8443 # is not enabled:
8444 #
8445 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8446 # &quot;domain&quot;: &quot;googleapis.com&quot;
8447 # &quot;metadata&quot;: {
8448 # &quot;resource&quot;: &quot;projects/123&quot;,
8449 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8450 # }
8451 # }
8452 #
8453 # This response indicates that the pubsub.googleapis.com API is not enabled.
8454 #
8455 # Example of an error that is returned when attempting to create a Spanner
8456 # instance in a region that is out of stock:
8457 #
8458 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8459 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8460 # &quot;metadata&quot;: {
8461 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8462 # }
8463 # }
8464 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8465 # is typically the registered service name of the tool or product that
8466 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8467 # generated by some common infrastructure, the error domain must be a
8468 # globally unique value that identifies the infrastructure. For Google API
8469 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8470 &quot;metadatas&quot;: { # Additional structured details about this error.
8471 #
8472 # Keys must match a regular expression of `a-z+` but should
8473 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8474 # length. When identifying the current value of an exceeded limit, the units
8475 # should be contained in the key, not the value. For example, rather than
8476 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8477 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8478 # instances that can be created in a single (batch) request.
8479 &quot;a_key&quot;: &quot;A String&quot;,
8480 },
8481 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8482 # proximate cause of the error. Error reasons are unique within a particular
8483 # domain of errors. This should be at most 63 characters and match a
8484 # regular expression of `A-Z+[A-Z0-9]`, which represents
8485 # UPPER_SNAKE_CASE.
8486 },
8487 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8488 #
8489 # For example, if a quota check failed with an error indicating the calling
8490 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8491 # directly to the right place in the developer console to flip the bit.
8492 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8493 { # Describes a URL link.
8494 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8495 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8496 },
8497 ],
8498 },
8499 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8500 # which can be attached to an RPC error.
8501 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8502 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8503 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8504 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8505 },
8506 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8507 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8508 &quot;a_key&quot;: &quot;A String&quot;,
8509 },
8510 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8511 # type or metric.
8512 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8513 # or metric.
8514 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8515 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8516 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8517 },
8518 },
8519 ],
8520 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8521 # This property is optional.
8522 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8523 },
8524 ],
8525 },
8526 &quot;getVersionOperationMetadata&quot;: {
8527 &quot;inlineSbomInfo&quot;: {
8528 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8529 # appropriate identifiers.
8530 &quot;a_key&quot;: &quot;A String&quot;,
8531 },
8532 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8533 # identifiers.
8534 &quot;a_key&quot;: &quot;A String&quot;,
8535 },
8536 },
8537 },
8538 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8539 # message that was returned, such as `NOT FOUND`.
8540 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8541 # status code that was returned. For example, a `404` means the
8542 # resource was not found.
8543 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8544 # defined by the server.
8545 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8546 # This value is inRFC3339
8547 # text format.
8548 &quot;instancesBulkInsertOperationMetadata&quot;: {
8549 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8550 # Example key: zones/us-central1-a
8551 &quot;a_key&quot;: {
8552 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8553 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8554 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8555 # error.
8556 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8557 # if the flow is rolling forward or rolling back.
8558 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8559 },
8560 },
8561 },
8562 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8563 # Operation resources.
8564 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8565 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8566 # group of operations results from a `bulkInsert` API request.
8567 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8568 # `update`, or `delete`, and so on.
8569 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8570 # There is no requirement that this be linear or support any granularity of
8571 # operations. This should not be used to guess when the operation will be
8572 # complete. This number should monotonically increase as the operation
8573 # progresses.
8574 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8575 # applicable when performing regional operations.
8576 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8577 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8578 # this field will contain information on all underlying zonal actions and
8579 # their state.
8580 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8581 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8582 # Example key: zones/us-central1-a
8583 &quot;a_key&quot;: {
8584 &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
8585 # populated.
8586 # different programming environments, including REST APIs and RPC APIs. It is
8587 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8588 # three pieces of data: error code, error message, and error details.
8589 #
8590 # You can find out more about this error model and how to work with it in the
8591 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8592 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8593 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8594 # message types for APIs to use.
8595 {
8596 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8597 },
8598 ],
8599 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8600 # user-facing error message should be localized and sent in the
8601 # google.rpc.Status.details field, or localized by the client.
8602 },
8603 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8604 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8605 },
8606 },
8607 },
8608 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8609 # This value is inRFC3339
8610 # text format.
8611 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8612 # following:
8613 # `PENDING`, `RUNNING`, or `DONE`.
8614 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8615 # operation.
8616 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8617 # of the target resource.
8618 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8619 # operations related to creating a snapshot, this points to the disk
8620 # that the snapshot was created from.
8621 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8622 # `[email protected]` or
8623 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8624 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8625 # operation, this field will be populated.
8626 {
8627 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8628 # Engine returns NO_RESULTS_ON_PAGE if there
8629 # are no results in the response.
8630 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8631 # value format. For example:
8632 #
8633 # &quot;data&quot;: [
8634 # {
8635 # &quot;key&quot;: &quot;scope&quot;,
8636 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8637 # }
8638 {
8639 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8640 # returned. For example, for warnings where there are no results in a list
8641 # request for a particular zone, this key might be scope and
8642 # the key value might be the zone name. Other examples might be a key
8643 # indicating a deprecated resource and a suggested replacement, or a
8644 # warning about invalid network settings (for example, if an instance
8645 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8646 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8647 },
8648 ],
8649 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8650 },
8651 ],
8652 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8653 # applicable when performing per-zone operations.
8654 }</pre>
8655 </div>
8656
8657 <div class="method">
8658 <code class="details" id="updateKmsKey">updateKmsKey(project, zone, disk, body=None, requestId=None, x__xgafv=None)</code>
8659 <pre>Rotates the customer-managed
8660 encryption key to the latest version for the specified persistent disk.
8661
8662 Args:
8663 project: string, Project ID for this request. (required)
8664 zone: string, The name of the zone for this request. (required)
8665 disk: string, Name of the Disk resource, should conform to RFC1035. (required)
8666 body: object, The request body.
8667 The object takes the form of:
8668
8669 {
8670 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The new KMS key to replace the current one on the disk. If empty, the disk
8671 # will be re-encrypted using the primary version of the disk&#x27;s current KMS
8672 # key.
8673 #
8674 # The KMS key can be provided in the following formats:
8675 #
8676 #
8677 # - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key
8678 #
8679 #
8680 # Where project is the project ID or
8681 # project number.
8682 }
8683
8684 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
8685 that if you must retry your request, the server will know to ignore the
8686 request if it has already been completed.
8687
8688 For example, consider a situation where you make an initial request and
8689 the request times out. If you make the request again with the same
8690 request ID, the server can check if original operation with the same
8691 request ID was received, and if so, will ignore the second request. This
8692 prevents clients from accidentally creating duplicate commitments.
8693
8694 The request ID must be
8695 a valid UUID with the exception that zero UUID is not supported
8696 (00000000-0000-0000-0000-000000000000).
8697 x__xgafv: string, V1 error format.
8698 Allowed values
8699 1 - v1 error format
8700 2 - v2 error format
8701
8702 Returns:
8703 An object of the form:
8704
8705 { # Represents an Operation resource.
8706 #
8707 # Google Compute Engine has three Operation resources:
8708 #
8709 # * [Global](/compute/docs/reference/rest/v1/globalOperations)
8710 # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
8711 # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
8712 #
8713 # You can use an operation resource to manage asynchronous API requests.
8714 # For more information, readHandling
8715 # API responses.
8716 #
8717 # Operations can be global, regional or zonal.
8718 #
8719 # - For global operations, use the `globalOperations`
8720 # resource.
8721 # - For regional operations, use the
8722 # `regionOperations` resource.
8723 # - For zonal operations, use
8724 # the `zoneOperations` resource.
8725 #
8726 #
8727 #
8728 # For more information, read
8729 # Global, Regional, and Zonal Resources.
8730 #
8731 # Note that completed Operation resources have a limited
8732 # retention period.
8733 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
8734 # Not present otherwise.
8735 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
8736 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
8737 # set when the operation is created.
8738 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
8739 # text format.
8740 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
8741 # this field will be populated.
8742 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
8743 # operation.
8744 {
8745 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
8746 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
8747 # details. There is a set of defined message types to use for providing
8748 # details.The syntax depends on the error code. For example,
8749 # QuotaExceededInfo will have details when the error code is
8750 # QUOTA_EXCEEDED.
8751 {
8752 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
8753 #
8754 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
8755 # is not enabled:
8756 #
8757 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
8758 # &quot;domain&quot;: &quot;googleapis.com&quot;
8759 # &quot;metadata&quot;: {
8760 # &quot;resource&quot;: &quot;projects/123&quot;,
8761 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
8762 # }
8763 # }
8764 #
8765 # This response indicates that the pubsub.googleapis.com API is not enabled.
8766 #
8767 # Example of an error that is returned when attempting to create a Spanner
8768 # instance in a region that is out of stock:
8769 #
8770 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
8771 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
8772 # &quot;metadata&quot;: {
8773 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
8774 # }
8775 # }
8776 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
8777 # is typically the registered service name of the tool or product that
8778 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
8779 # generated by some common infrastructure, the error domain must be a
8780 # globally unique value that identifies the infrastructure. For Google API
8781 # infrastructure, the error domain is &quot;googleapis.com&quot;.
8782 &quot;metadatas&quot;: { # Additional structured details about this error.
8783 #
8784 # Keys must match a regular expression of `a-z+` but should
8785 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
8786 # length. When identifying the current value of an exceeded limit, the units
8787 # should be contained in the key, not the value. For example, rather than
8788 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
8789 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
8790 # instances that can be created in a single (batch) request.
8791 &quot;a_key&quot;: &quot;A String&quot;,
8792 },
8793 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
8794 # proximate cause of the error. Error reasons are unique within a particular
8795 # domain of errors. This should be at most 63 characters and match a
8796 # regular expression of `A-Z+[A-Z0-9]`, which represents
8797 # UPPER_SNAKE_CASE.
8798 },
8799 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
8800 #
8801 # For example, if a quota check failed with an error indicating the calling
8802 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
8803 # directly to the right place in the developer console to flip the bit.
8804 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
8805 { # Describes a URL link.
8806 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
8807 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
8808 },
8809 ],
8810 },
8811 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
8812 # which can be attached to an RPC error.
8813 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
8814 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
8815 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
8816 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
8817 },
8818 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
8819 &quot;dimensions&quot;: { # The map holding related quota dimensions.
8820 &quot;a_key&quot;: &quot;A String&quot;,
8821 },
8822 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
8823 # type or metric.
8824 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
8825 # or metric.
8826 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
8827 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
8828 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
8829 },
8830 },
8831 ],
8832 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
8833 # This property is optional.
8834 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
8835 },
8836 ],
8837 },
8838 &quot;getVersionOperationMetadata&quot;: {
8839 &quot;inlineSbomInfo&quot;: {
8840 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
8841 # appropriate identifiers.
8842 &quot;a_key&quot;: &quot;A String&quot;,
8843 },
8844 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
8845 # identifiers.
8846 &quot;a_key&quot;: &quot;A String&quot;,
8847 },
8848 },
8849 },
8850 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
8851 # message that was returned, such as `NOT FOUND`.
8852 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
8853 # status code that was returned. For example, a `404` means the
8854 # resource was not found.
8855 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
8856 # defined by the server.
8857 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
8858 # This value is inRFC3339
8859 # text format.
8860 &quot;instancesBulkInsertOperationMetadata&quot;: {
8861 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
8862 # Example key: zones/us-central1-a
8863 &quot;a_key&quot;: {
8864 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
8865 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
8866 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
8867 # error.
8868 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
8869 # if the flow is rolling forward or rolling back.
8870 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
8871 },
8872 },
8873 },
8874 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
8875 # Operation resources.
8876 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
8877 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
8878 # group of operations results from a `bulkInsert` API request.
8879 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
8880 # `update`, or `delete`, and so on.
8881 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
8882 # There is no requirement that this be linear or support any granularity of
8883 # operations. This should not be used to guess when the operation will be
8884 # complete. This number should monotonically increase as the operation
8885 # progresses.
8886 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
8887 # applicable when performing regional operations.
8888 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
8889 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
8890 # this field will contain information on all underlying zonal actions and
8891 # their state.
8892 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
8893 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
8894 # Example key: zones/us-central1-a
8895 &quot;a_key&quot;: {
8896 &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
8897 # populated.
8898 # different programming environments, including REST APIs and RPC APIs. It is
8899 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
8900 # three pieces of data: error code, error message, and error details.
8901 #
8902 # You can find out more about this error model and how to work with it in the
8903 # [API Design Guide](https://cloud.google.com/apis/design/errors).
8904 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
8905 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
8906 # message types for APIs to use.
8907 {
8908 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
8909 },
8910 ],
8911 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
8912 # user-facing error message should be localized and sent in the
8913 # google.rpc.Status.details field, or localized by the client.
8914 },
8915 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
8916 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
8917 },
8918 },
8919 },
8920 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
8921 # This value is inRFC3339
8922 # text format.
8923 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
8924 # following:
8925 # `PENDING`, `RUNNING`, or `DONE`.
8926 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
8927 # operation.
8928 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
8929 # of the target resource.
8930 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
8931 # operations related to creating a snapshot, this points to the disk
8932 # that the snapshot was created from.
8933 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
8934 # `[email protected]` or
8935 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
8936 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
8937 # operation, this field will be populated.
8938 {
8939 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
8940 # Engine returns NO_RESULTS_ON_PAGE if there
8941 # are no results in the response.
8942 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
8943 # value format. For example:
8944 #
8945 # &quot;data&quot;: [
8946 # {
8947 # &quot;key&quot;: &quot;scope&quot;,
8948 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
8949 # }
8950 {
8951 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
8952 # returned. For example, for warnings where there are no results in a list
8953 # request for a particular zone, this key might be scope and
8954 # the key value might be the zone name. Other examples might be a key
8955 # indicating a deprecated resource and a suggested replacement, or a
8956 # warning about invalid network settings (for example, if an instance
8957 # attempts to perform IP forwarding but is not enabled for IP forwarding).
8958 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
8959 },
8960 ],
8961 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
8962 },
8963 ],
8964 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
8965 # applicable when performing per-zone operations.
8966 }</pre>
8967 </div>
8968
8969 </body></html>