Debian Codegraph @

docs/dyn/compute_alpha.snapshots.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.snapshots.html">snapshots</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <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>
79 <p class="firstline">Retrieves an aggregated list of all of the snapshots in your project</p>
80 <p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next()</a></code></p>
82 <p class="firstline">Retrieves the next page of results.</p>
83 <p class="toc_element">
84 <code><a href="#close">close()</a></code></p>
85 <p class="firstline">Close httplib2 connections.</p>
86 <p class="toc_element">
87 <code><a href="#delete">delete(project, snapshot, requestId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Deletes the specified Snapshot resource. Keep in mind that deleting</p>
89 <p class="toc_element">
90 <code><a href="#get">get(project, snapshot, x__xgafv=None)</a></code></p>
91 <p class="firstline">Returns the specified Snapshot resource.</p>
92 <p class="toc_element">
93 <code><a href="#getEffectiveRecycleBinRule">getEffectiveRecycleBinRule(project, snapshot, x__xgafv=None)</a></code></p>
94 <p class="firstline">Returns the effective recycle bin rule for a snapshot by merging org and</p>
95 <p class="toc_element">
96 <code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Gets the access control policy for a resource. May be empty if no such</p>
98 <p class="toc_element">
99 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Creates a snapshot in the specified project using the data included</p>
101 <p class="toc_element">
102 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
103 <p class="firstline">Retrieves the list of Snapshot resources contained within</p>
104 <p class="toc_element">
105 <code><a href="#list_next">list_next()</a></code></p>
106 <p class="firstline">Retrieves the next page of results.</p>
107 <p class="toc_element">
108 <code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Sets the access control policy on the specified resource.</p>
110 <p class="toc_element">
111 <code><a href="#setLabels">setLabels(project, resource, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Sets the labels on a snapshot. To learn more about labels, read theLabeling</p>
113 <p class="toc_element">
114 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">Returns permissions that a caller has on the specified resource.</p>
116 <p class="toc_element">
117 <code><a href="#updateKmsKey">updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Rotates the customer-managed</p>
119 <h3>Method Details</h3>
120 <div class="method">
121 <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>
122 <pre>Retrieves an aggregated list of all of the snapshots in your project
123 across all regions and global scope.
124
125 To prevent failure, Google recommends that you set the
126 `returnPartialSuccess` parameter to `true`.
127
128 Args:
129 project: string, Project ID for this request. (required)
130 filter: string, A filter expression that filters resources listed in the response. Most
131 Compute resources support two types of filter expressions:
132 expressions that support regular expressions and expressions that follow
133 API improvement proposal AIP-160.
134 These two types of filter expressions cannot be mixed in one request.
135
136 If you want to use AIP-160, your expression must specify the field name, an
137 operator, and the value that you want to use for filtering. The value
138 must be a string, a number, or a boolean. The operator
139 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
140
141 For example, if you are filtering Compute Engine instances, you can
142 exclude instances named `example-instance` by specifying
143 `name != example-instance`.
144
145 The `:*` comparison can be used to test whether a key has been defined.
146 For example, to find all objects with `owner` label use:
147 ```
148 labels.owner:*
149 ```
150
151 You can also filter nested fields. For example, you could specify
152 `scheduling.automaticRestart = false` to include instances only
153 if they are not scheduled for automatic restarts. You can use filtering
154 on nested fields to filter based onresource labels.
155
156 To filter on multiple expressions, provide each separate expression within
157 parentheses. For example:
158 ```
159 (scheduling.automaticRestart = true)
160 (cpuPlatform = &quot;Intel Skylake&quot;)
161 ```
162 By default, each expression is an `AND` expression. However, you
163 can include `AND` and `OR` expressions explicitly.
164 For example:
165 ```
166 (cpuPlatform = &quot;Intel Skylake&quot;) OR
167 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
168 (scheduling.automaticRestart = true)
169 ```
170
171 If you want to use a regular expression, use the `eq` (equal) or `ne`
172 (not equal) operator against a single un-parenthesized expression with or
173 without quotes or against multiple parenthesized expressions. Examples:
174
175 `fieldname eq unquoted literal`
176 `fieldname eq &#x27;single quoted literal&#x27;`
177 `fieldname eq &quot;double quoted literal&quot;`
178 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
179
180 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
181 The literal value must match the entire field.
182
183 For example, to filter for instances that do not end with name &quot;instance&quot;,
184 you would use `name ne .*instance`.
185
186 You cannot combine constraints on multiple fields using regular
187 expressions.
188 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
189 global) should be included in the response. For new resource types added
190 after this field, the flag has no effect as new resource types will always
191 include every visible scope for each scope type in response. For resource
192 types which predate this field, if this flag is omitted or false, only
193 scopes of the scope types where the resource type is expected to be found
194 will be included.
195 maxResults: integer, The maximum number of results per page that should be returned.
196 If the number of available results is larger than `maxResults`,
197 Compute Engine returns a `nextPageToken` that can be used to get
198 the next page of results in subsequent list requests. Acceptable values are
199 `0` to `500`, inclusive. (Default: `500`)
200 orderBy: string, Sorts list results by a certain order. By default, results
201 are returned in alphanumerical order based on the resource name.
202
203 You can also sort results in descending order based on the creation
204 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
205 results based on the `creationTimestamp` field in
206 reverse chronological order (newest result first). Use this to sort
207 resources like operations so that the newest operation is returned first.
208
209 Currently, only sorting by `name` or
210 `creationTimestamp desc` is supported.
211 pageToken: string, Specifies a page token to use. Set `pageToken` to the
212 `nextPageToken` returned by a previous list request to get
213 the next page of results.
214 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
215 of failure. The default value is false.
216
217 For example, when partial success behavior is enabled, aggregatedList for a
218 single zone scope either returns all resources in the zone or no resources,
219 with an error code.
220 serviceProjectNumber: string, The Shared VPC service project id or service project number for which
221 aggregated list request is invoked for subnetworks list-usable api.
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227 Returns:
228 An object of the form:
229
230 {
231 &quot;etag&quot;: &quot;A String&quot;,
232 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
233 &quot;items&quot;: { # A list of SnapshotsScopedList resources.
234 &quot;a_key&quot;: { # [Output Only] Name of the scope containing this set of snapshots.
235 &quot;snapshots&quot;: [ # [Output Only] A list of snapshots contained in this scope.
236 { # Represents a Persistent Disk Snapshot resource.
237 #
238 # You can use snapshots to back up data on a regular interval. For more
239 # information, read Creating
240 # persistent disk snapshots.
241 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
242 # ARM64 or X86_64.
243 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
244 # applying resource policy on the target disk.
245 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
246 # specified name. The chain name must be 1-63 characters long and comply
247 # with RFC1035. This is an uncommon option only for advanced service
248 # owners who needs to create separate snapshot chains, for example,
249 # for chargeback tracking. When you describe your snapshot resource, this
250 # field is visible only if it has a non-empty value.
251 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
252 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
253 # text format.
254 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
255 # create the resource.
256 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
257 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
258 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
259 # [Output Only]: This field is not set by user, but from source disk.
260 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
261 # informing the OS to prepare for the snapshot process.
262 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
263 # Applicable only for bootable images. Read
264 # Enabling guest operating system features to see a list of available
265 # options.
266 { # Guest OS features.
267 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
268 # separate values. Set to one or more of the following values:
269 #
270 # - VIRTIO_SCSI_MULTIQUEUE
271 # - WINDOWS
272 # - MULTI_IP_SUBNET
273 # - UEFI_COMPATIBLE
274 # - GVNIC
275 # - SEV_CAPABLE
276 # - SUSPEND_RESUME_COMPATIBLE
277 # - SEV_LIVE_MIGRATABLE_V2
278 # - SEV_SNP_CAPABLE
279 # - TDX_CAPABLE
280 # - IDPF
281 # - SNP_SVSM_CAPABLE
282 # - CCA_CAPABLE
283 #
284 #
285 # For more information, see
286 # Enabling guest operating system features.
287 },
288 ],
289 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
290 # defined by the server.
291 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
292 # for Snapshot resources.
293 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
294 # essentially a hash of the labels set used for optimistic locking. The
295 # fingerprint is initially generated by Compute Engine and changes after
296 # every request to modify or update labels. You must always provide an
297 # up-to-date fingerprint hash in order to update or change labels,
298 # otherwise the request will fail with error412 conditionNotMet.
299 #
300 # To see the latest fingerprint, make a get() request to
301 # retrieve a snapshot.
302 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
303 # the setLabels method.
304 # Label values may be empty.
305 &quot;a_key&quot;: &quot;A String&quot;,
306 },
307 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
308 # to this snapshot.
309 &quot;A String&quot;,
310 ],
311 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
312 # snapshot. This can be because the original image had licenses attached
313 # (such as a Windows image).
314 &quot;A String&quot;,
315 ],
316 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
317 # resources.
318 # This field is for use by internal tools that use the public API.
319 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
320 # automatically.
321 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
322 # The name must be 1-63 characters long, and comply withRFC1035.
323 # Specifically, the name must be 1-63 characters long and match the regular
324 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
325 # character must be a lowercase letter, and all following characters must be
326 # a dash, lowercase letter, or digit, except the last character, which cannot
327 # be a dash.
328 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
329 # as part of resource payload.
330 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
331 # the same definition as resource
332 # manager tags. Keys and values can be either in numeric format,
333 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
334 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
335 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
336 # PATCH) when empty.
337 &quot;a_key&quot;: &quot;A String&quot;,
338 },
339 },
340 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
341 # for regional snapshots.
342 &quot;resourceStatus&quot;: { # Output only. [Output only] ResourceStatus of the Snapshot resource
343 &quot;scheduledDeletionTime&quot;: &quot;A String&quot;, # Output only. [Output only] Scheduled deletion time of the snapshot. The snapshot will
344 # be deleted by the at any point within one hour after the deletion time.
345 },
346 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
347 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
348 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
349 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
350 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
351 # encryption key.
352 #
353 # After you encrypt a snapshot using a customer-supplied key, you must
354 # provide the same key if you use the snapshot later. For example, you must
355 # provide the encryption key when you create a disk from the encrypted
356 # snapshot in a future request.
357 #
358 # Customer-supplied encryption keys do not protect access to metadata
359 # of the snapshot.
360 #
361 # If you do not provide an encryption key when creating the snapshot, then
362 # the snapshot will be encrypted using an automatically generated key and you
363 # do not need to provide a key to use the snapshot later.
364 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
365 # For example:
366 #
367 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
368 # key_region/cryptoKeys/key
369 #
370 # The fully-qualifed key name may be returned for resource GET requests. For
371 # example:
372 #
373 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
374 # key_region/cryptoKeys/key
375 # /cryptoKeyVersions/1
376 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
377 # key. If absent, the Compute Engine default service account is used.
378 # For example:
379 #
380 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
381 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
382 # encryption key, encoded in RFC
383 # 4648 base64 to either encrypt or decrypt this resource. You can
384 # provide either the rawKey or thersaEncryptedKey.
385 # For example:
386 #
387 # &quot;rawKey&quot;:
388 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
389 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
390 # customer-supplied encryption key to either encrypt or decrypt this
391 # resource. You can provide either the rawKey or thersaEncryptedKey.
392 # For example:
393 #
394 # &quot;rsaEncryptedKey&quot;:
395 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
396 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
397 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
398 #
399 # The key must meet the following requirements before you can provide it to
400 # Compute Engine:
401 #
402 # 1. The key is wrapped using a RSA public key certificate provided by
403 # Google.
404 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
405 # encoding.
406 #
407 # Gets the RSA public key certificate provided by Google at:
408 #
409 #
410 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
411 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
412 # 4648 base64 encoded SHA-256 hash of the customer-supplied
413 # encryption key that protects this resource.
414 },
415 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
416 # belongs to. The usage of snapshot group feature is restricted.
417 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
418 # of snapshot group feature is restricted.
419 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
420 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
421 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
422 # encryption key of the source disk. Required if the source disk is
423 # protected by a customer-supplied encryption key.
424 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
425 # For example:
426 #
427 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
428 # key_region/cryptoKeys/key
429 #
430 # The fully-qualifed key name may be returned for resource GET requests. For
431 # example:
432 #
433 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
434 # key_region/cryptoKeys/key
435 # /cryptoKeyVersions/1
436 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
437 # key. If absent, the Compute Engine default service account is used.
438 # For example:
439 #
440 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
441 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
442 # encryption key, encoded in RFC
443 # 4648 base64 to either encrypt or decrypt this resource. You can
444 # provide either the rawKey or thersaEncryptedKey.
445 # For example:
446 #
447 # &quot;rawKey&quot;:
448 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
449 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
450 # customer-supplied encryption key to either encrypt or decrypt this
451 # resource. You can provide either the rawKey or thersaEncryptedKey.
452 # For example:
453 #
454 # &quot;rsaEncryptedKey&quot;:
455 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
456 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
457 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
458 #
459 # The key must meet the following requirements before you can provide it to
460 # Compute Engine:
461 #
462 # 1. The key is wrapped using a RSA public key certificate provided by
463 # Google.
464 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
465 # encoding.
466 #
467 # Gets the RSA public key certificate provided by Google at:
468 #
469 #
470 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
471 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
472 # 4648 base64 encoded SHA-256 hash of the customer-supplied
473 # encryption key that protects this resource.
474 },
475 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
476 # snapshot.
477 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
478 # value may be used to determine whether the snapshot was taken from the
479 # current or a previous instance of a given disk name.
480 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
481 # this as a partial or full URL to the resource. For example, the following
482 # are valid values:
483 #
484 #
485 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
486 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
487 # - zones/zone/instantSnapshots/instantSnapshot
488 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
489 # Snapshot.
490 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
491 # For example:
492 #
493 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
494 # key_region/cryptoKeys/key
495 #
496 # The fully-qualifed key name may be returned for resource GET requests. For
497 # example:
498 #
499 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
500 # key_region/cryptoKeys/key
501 # /cryptoKeyVersions/1
502 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
503 # key. If absent, the Compute Engine default service account is used.
504 # For example:
505 #
506 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
507 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
508 # encryption key, encoded in RFC
509 # 4648 base64 to either encrypt or decrypt this resource. You can
510 # provide either the rawKey or thersaEncryptedKey.
511 # For example:
512 #
513 # &quot;rawKey&quot;:
514 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
515 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
516 # customer-supplied encryption key to either encrypt or decrypt this
517 # resource. You can provide either the rawKey or thersaEncryptedKey.
518 # For example:
519 #
520 # &quot;rsaEncryptedKey&quot;:
521 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
522 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
523 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
524 #
525 # The key must meet the following requirements before you can provide it to
526 # Compute Engine:
527 #
528 # 1. The key is wrapped using a RSA public key certificate provided by
529 # Google.
530 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
531 # encoding.
532 #
533 # Gets the RSA public key certificate provided by Google at:
534 #
535 #
536 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
537 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
538 # 4648 base64 encoded SHA-256 hash of the customer-supplied
539 # encryption key that protects this resource.
540 },
541 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
542 # snapshot. This value identifies the exact instant snapshot that was used to
543 # create this snapshot. For example, if you created the snapshot from an
544 # instant snapshot that was later deleted and recreated under the same name,
545 # the source instant snapshot ID would identify the exact instant snapshot
546 # that was used.
547 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
548 # scheduled snapshot.
549 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
550 # scheduled snapshot.
551 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
552 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
553 # share storage, this number is expected to change with snapshot
554 # creation/deletion.
555 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
556 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
557 # [Output Only] An indicator whether storageBytes is in a
558 # stable state or it is being adjusted as a result of shared storage
559 # reallocation. This status can either be unset, meaning the snapshot is
560 # being created, or UP_TO_DATE, meaning the size of the snapshot
561 # is up-to-date.
562 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
563 # multi-regional).
564 &quot;A String&quot;,
565 ],
566 },
567 ],
568 &quot;warning&quot;: { # [Output Only] Informational warning which replaces the list of snapshots
569 # when the list is empty.
570 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
571 # Engine returns NO_RESULTS_ON_PAGE if there
572 # are no results in the response.
573 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
574 # value format. For example:
575 #
576 # &quot;data&quot;: [
577 # {
578 # &quot;key&quot;: &quot;scope&quot;,
579 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
580 # }
581 {
582 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
583 # returned. For example, for warnings where there are no results in a list
584 # request for a particular zone, this key might be scope and
585 # the key value might be the zone name. Other examples might be a key
586 # indicating a deprecated resource and a suggested replacement, or a
587 # warning about invalid network settings (for example, if an instance
588 # attempts to perform IP forwarding but is not enabled for IP forwarding).
589 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
590 },
591 ],
592 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
593 },
594 },
595 },
596 &quot;kind&quot;: &quot;compute#snapshotAggregatedList&quot;, # Output only. [Output Only] Type of resource. Alwayscompute#snapshotAggregatedList for aggregated lists of
597 # snapshots.
598 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
599 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
600 # the query parameter pageToken in the next list request.
601 # Subsequent list requests will have their own nextPageToken to
602 # continue paging through the results.
603 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
604 &quot;unreachables&quot;: [ # Output only. [Output Only] Unreachable resources.
605 &quot;A String&quot;,
606 ],
607 &quot;warning&quot;: { # [Output Only] Informational warning message.
608 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
609 # Engine returns NO_RESULTS_ON_PAGE if there
610 # are no results in the response.
611 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
612 # value format. For example:
613 #
614 # &quot;data&quot;: [
615 # {
616 # &quot;key&quot;: &quot;scope&quot;,
617 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
618 # }
619 {
620 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
621 # returned. For example, for warnings where there are no results in a list
622 # request for a particular zone, this key might be scope and
623 # the key value might be the zone name. Other examples might be a key
624 # indicating a deprecated resource and a suggested replacement, or a
625 # warning about invalid network settings (for example, if an instance
626 # attempts to perform IP forwarding but is not enabled for IP forwarding).
627 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
628 },
629 ],
630 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
631 },
632 }</pre>
633 </div>
634
635 <div class="method">
636 <code class="details" id="aggregatedList_next">aggregatedList_next()</code>
637 <pre>Retrieves the next page of results.
638
639 Args:
640 previous_request: The request for the previous page. (required)
641 previous_response: The response from the request for the previous page. (required)
642
643 Returns:
644 A request object that you can call &#x27;execute()&#x27; on to request the next
645 page. Returns None if there are no more items in the collection.
646 </pre>
647 </div>
648
649 <div class="method">
650 <code class="details" id="close">close()</code>
651 <pre>Close httplib2 connections.</pre>
652 </div>
653
654 <div class="method">
655 <code class="details" id="delete">delete(project, snapshot, requestId=None, x__xgafv=None)</code>
656 <pre>Deletes the specified Snapshot resource. Keep in mind that deleting
657 a single snapshot might not necessarily delete all the data on that
658 snapshot. If any data on the snapshot that is marked for deletion is
659 needed for subsequent snapshots, the data will be moved to the next
660 corresponding snapshot.
661
662 For more information, seeDeleting
663 snapshots.
664
665 Args:
666 project: string, Project ID for this request. (required)
667 snapshot: string, Name of the Snapshot resource to delete. (required)
668 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
669 that if you must retry your request, the server will know to ignore the
670 request if it has already been completed.
671
672 For example, consider a situation where you make an initial request and
673 the request times out. If you make the request again with the same
674 request ID, the server can check if original operation with the same
675 request ID was received, and if so, will ignore the second request. This
676 prevents clients from accidentally creating duplicate commitments.
677
678 The request ID must be
679 a valid UUID with the exception that zero UUID is not supported
680 (00000000-0000-0000-0000-000000000000).
681 x__xgafv: string, V1 error format.
682 Allowed values
683 1 - v1 error format
684 2 - v2 error format
685
686 Returns:
687 An object of the form:
688
689 { # Represents an Operation resource.
690 #
691 # Google Compute Engine has three Operation resources:
692 #
693 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
694 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
695 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
696 #
697 # You can use an operation resource to manage asynchronous API requests.
698 # For more information, readHandling
699 # API responses.
700 #
701 # Operations can be global, regional or zonal.
702 #
703 # - For global operations, use the `globalOperations`
704 # resource.
705 # - For regional operations, use the
706 # `regionOperations` resource.
707 # - For zonal operations, use
708 # the `zoneOperations` resource.
709 #
710 #
711 #
712 # For more information, read
713 # Global, Regional, and Zonal Resources.
714 #
715 # Note that completed Operation resources have a limited
716 # retention period.
717 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
718 # Not present otherwise.
719 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
720 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
721 # set when the operation is created.
722 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
723 # text format.
724 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
725 # this field will be populated.
726 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
727 # operation.
728 {
729 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
730 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
731 # details. There is a set of defined message types to use for providing
732 # details.The syntax depends on the error code. For example,
733 # QuotaExceededInfo will have details when the error code is
734 # QUOTA_EXCEEDED.
735 {
736 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
737 #
738 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
739 # is not enabled:
740 #
741 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
742 # &quot;domain&quot;: &quot;googleapis.com&quot;
743 # &quot;metadata&quot;: {
744 # &quot;resource&quot;: &quot;projects/123&quot;,
745 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
746 # }
747 # }
748 #
749 # This response indicates that the pubsub.googleapis.com API is not enabled.
750 #
751 # Example of an error that is returned when attempting to create a Spanner
752 # instance in a region that is out of stock:
753 #
754 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
755 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
756 # &quot;metadata&quot;: {
757 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
758 # }
759 # }
760 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
761 # is typically the registered service name of the tool or product that
762 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
763 # generated by some common infrastructure, the error domain must be a
764 # globally unique value that identifies the infrastructure. For Google API
765 # infrastructure, the error domain is &quot;googleapis.com&quot;.
766 &quot;metadatas&quot;: { # Additional structured details about this error.
767 #
768 # Keys must match a regular expression of `a-z+` but should
769 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
770 # length. When identifying the current value of an exceeded limit, the units
771 # should be contained in the key, not the value. For example, rather than
772 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
773 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
774 # instances that can be created in a single (batch) request.
775 &quot;a_key&quot;: &quot;A String&quot;,
776 },
777 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
778 # proximate cause of the error. Error reasons are unique within a particular
779 # domain of errors. This should be at most 63 characters and match a
780 # regular expression of `A-Z+[A-Z0-9]`, which represents
781 # UPPER_SNAKE_CASE.
782 },
783 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
784 #
785 # For example, if a quota check failed with an error indicating the calling
786 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
787 # directly to the right place in the developer console to flip the bit.
788 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
789 { # Describes a URL link.
790 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
791 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
792 },
793 ],
794 },
795 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
796 # which can be attached to an RPC error.
797 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
798 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
799 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
800 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
801 },
802 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
803 &quot;dimensions&quot;: { # The map holding related quota dimensions.
804 &quot;a_key&quot;: &quot;A String&quot;,
805 },
806 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
807 # type or metric.
808 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
809 # or metric.
810 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
811 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
812 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
813 },
814 },
815 ],
816 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
817 # This property is optional.
818 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
819 },
820 ],
821 },
822 &quot;getVersionOperationMetadata&quot;: {
823 &quot;inlineSbomInfo&quot;: {
824 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
825 # appropriate identifiers.
826 &quot;a_key&quot;: &quot;A String&quot;,
827 },
828 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
829 # identifiers.
830 &quot;a_key&quot;: &quot;A String&quot;,
831 },
832 },
833 },
834 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
835 # message that was returned, such as `NOT FOUND`.
836 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
837 # status code that was returned. For example, a `404` means the
838 # resource was not found.
839 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
840 # defined by the server.
841 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
842 # This value is inRFC3339
843 # text format.
844 &quot;instancesBulkInsertOperationMetadata&quot;: {
845 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
846 # Example key: zones/us-central1-a
847 &quot;a_key&quot;: {
848 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
849 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
850 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
851 # error.
852 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
853 # if the flow is rolling forward or rolling back.
854 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
855 },
856 },
857 },
858 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
859 # Operation resources.
860 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
861 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
862 # group of operations results from a `bulkInsert` API request.
863 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
864 # `update`, or `delete`, and so on.
865 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
866 # There is no requirement that this be linear or support any granularity of
867 # operations. This should not be used to guess when the operation will be
868 # complete. This number should monotonically increase as the operation
869 # progresses.
870 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
871 # applicable when performing regional operations.
872 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
873 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
874 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
875 # this field will contain information on all underlying zonal actions and
876 # their state.
877 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
878 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
879 # Example key: zones/us-central1-a
880 &quot;a_key&quot;: {
881 &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
882 # populated.
883 # different programming environments, including REST APIs and RPC APIs. It is
884 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
885 # three pieces of data: error code, error message, and error details.
886 #
887 # You can find out more about this error model and how to work with it in the
888 # [API Design Guide](https://cloud.google.com/apis/design/errors).
889 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
890 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
891 # message types for APIs to use.
892 {
893 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
894 },
895 ],
896 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
897 # user-facing error message should be localized and sent in the
898 # google.rpc.Status.details field, or localized by the client.
899 },
900 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
901 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
902 },
903 },
904 },
905 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
906 # This value is inRFC3339
907 # text format.
908 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
909 # following:
910 # `PENDING`, `RUNNING`, or `DONE`.
911 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
912 # operation.
913 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
914 # of the target resource.
915 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
916 # operations related to creating a snapshot, this points to the disk
917 # that the snapshot was created from.
918 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
919 # `[email protected]` or
920 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
921 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
922 # operation, this field will be populated.
923 {
924 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
925 # Engine returns NO_RESULTS_ON_PAGE if there
926 # are no results in the response.
927 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
928 # value format. For example:
929 #
930 # &quot;data&quot;: [
931 # {
932 # &quot;key&quot;: &quot;scope&quot;,
933 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
934 # }
935 {
936 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
937 # returned. For example, for warnings where there are no results in a list
938 # request for a particular zone, this key might be scope and
939 # the key value might be the zone name. Other examples might be a key
940 # indicating a deprecated resource and a suggested replacement, or a
941 # warning about invalid network settings (for example, if an instance
942 # attempts to perform IP forwarding but is not enabled for IP forwarding).
943 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
944 },
945 ],
946 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
947 },
948 ],
949 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
950 # applicable when performing per-zone operations.
951 }</pre>
952 </div>
953
954 <div class="method">
955 <code class="details" id="get">get(project, snapshot, x__xgafv=None)</code>
956 <pre>Returns the specified Snapshot resource.
957
958 Args:
959 project: string, Project ID for this request. (required)
960 snapshot: string, Name of the Snapshot resource to return. (required)
961 x__xgafv: string, V1 error format.
962 Allowed values
963 1 - v1 error format
964 2 - v2 error format
965
966 Returns:
967 An object of the form:
968
969 { # Represents a Persistent Disk Snapshot resource.
970 #
971 # You can use snapshots to back up data on a regular interval. For more
972 # information, read Creating
973 # persistent disk snapshots.
974 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
975 # ARM64 or X86_64.
976 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
977 # applying resource policy on the target disk.
978 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
979 # specified name. The chain name must be 1-63 characters long and comply
980 # with RFC1035. This is an uncommon option only for advanced service
981 # owners who needs to create separate snapshot chains, for example,
982 # for chargeback tracking. When you describe your snapshot resource, this
983 # field is visible only if it has a non-empty value.
984 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
985 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
986 # text format.
987 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
988 # create the resource.
989 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
990 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
991 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
992 # [Output Only]: This field is not set by user, but from source disk.
993 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
994 # informing the OS to prepare for the snapshot process.
995 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
996 # Applicable only for bootable images. Read
997 # Enabling guest operating system features to see a list of available
998 # options.
999 { # Guest OS features.
1000 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1001 # separate values. Set to one or more of the following values:
1002 #
1003 # - VIRTIO_SCSI_MULTIQUEUE
1004 # - WINDOWS
1005 # - MULTI_IP_SUBNET
1006 # - UEFI_COMPATIBLE
1007 # - GVNIC
1008 # - SEV_CAPABLE
1009 # - SUSPEND_RESUME_COMPATIBLE
1010 # - SEV_LIVE_MIGRATABLE_V2
1011 # - SEV_SNP_CAPABLE
1012 # - TDX_CAPABLE
1013 # - IDPF
1014 # - SNP_SVSM_CAPABLE
1015 # - CCA_CAPABLE
1016 #
1017 #
1018 # For more information, see
1019 # Enabling guest operating system features.
1020 },
1021 ],
1022 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1023 # defined by the server.
1024 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1025 # for Snapshot resources.
1026 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1027 # essentially a hash of the labels set used for optimistic locking. The
1028 # fingerprint is initially generated by Compute Engine and changes after
1029 # every request to modify or update labels. You must always provide an
1030 # up-to-date fingerprint hash in order to update or change labels,
1031 # otherwise the request will fail with error412 conditionNotMet.
1032 #
1033 # To see the latest fingerprint, make a get() request to
1034 # retrieve a snapshot.
1035 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1036 # the setLabels method.
1037 # Label values may be empty.
1038 &quot;a_key&quot;: &quot;A String&quot;,
1039 },
1040 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1041 # to this snapshot.
1042 &quot;A String&quot;,
1043 ],
1044 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1045 # snapshot. This can be because the original image had licenses attached
1046 # (such as a Windows image).
1047 &quot;A String&quot;,
1048 ],
1049 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
1050 # resources.
1051 # This field is for use by internal tools that use the public API.
1052 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
1053 # automatically.
1054 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1055 # The name must be 1-63 characters long, and comply withRFC1035.
1056 # Specifically, the name must be 1-63 characters long and match the regular
1057 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1058 # character must be a lowercase letter, and all following characters must be
1059 # a dash, lowercase letter, or digit, except the last character, which cannot
1060 # be a dash.
1061 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1062 # as part of resource payload.
1063 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
1064 # the same definition as resource
1065 # manager tags. Keys and values can be either in numeric format,
1066 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1067 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1068 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1069 # PATCH) when empty.
1070 &quot;a_key&quot;: &quot;A String&quot;,
1071 },
1072 },
1073 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
1074 # for regional snapshots.
1075 &quot;resourceStatus&quot;: { # Output only. [Output only] ResourceStatus of the Snapshot resource
1076 &quot;scheduledDeletionTime&quot;: &quot;A String&quot;, # Output only. [Output only] Scheduled deletion time of the snapshot. The snapshot will
1077 # be deleted by the at any point within one hour after the deletion time.
1078 },
1079 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1080 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1081 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1082 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1083 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1084 # encryption key.
1085 #
1086 # After you encrypt a snapshot using a customer-supplied key, you must
1087 # provide the same key if you use the snapshot later. For example, you must
1088 # provide the encryption key when you create a disk from the encrypted
1089 # snapshot in a future request.
1090 #
1091 # Customer-supplied encryption keys do not protect access to metadata
1092 # of the snapshot.
1093 #
1094 # If you do not provide an encryption key when creating the snapshot, then
1095 # the snapshot will be encrypted using an automatically generated key and you
1096 # do not need to provide a key to use the snapshot later.
1097 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1098 # For example:
1099 #
1100 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1101 # key_region/cryptoKeys/key
1102 #
1103 # The fully-qualifed key name may be returned for resource GET requests. For
1104 # example:
1105 #
1106 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1107 # key_region/cryptoKeys/key
1108 # /cryptoKeyVersions/1
1109 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1110 # key. If absent, the Compute Engine default service account is used.
1111 # For example:
1112 #
1113 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1114 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1115 # encryption key, encoded in RFC
1116 # 4648 base64 to either encrypt or decrypt this resource. You can
1117 # provide either the rawKey or thersaEncryptedKey.
1118 # For example:
1119 #
1120 # &quot;rawKey&quot;:
1121 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1122 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1123 # customer-supplied encryption key to either encrypt or decrypt this
1124 # resource. You can provide either the rawKey or thersaEncryptedKey.
1125 # For example:
1126 #
1127 # &quot;rsaEncryptedKey&quot;:
1128 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1129 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1130 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1131 #
1132 # The key must meet the following requirements before you can provide it to
1133 # Compute Engine:
1134 #
1135 # 1. The key is wrapped using a RSA public key certificate provided by
1136 # Google.
1137 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1138 # encoding.
1139 #
1140 # Gets the RSA public key certificate provided by Google at:
1141 #
1142 #
1143 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1144 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1145 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1146 # encryption key that protects this resource.
1147 },
1148 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
1149 # belongs to. The usage of snapshot group feature is restricted.
1150 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
1151 # of snapshot group feature is restricted.
1152 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
1153 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
1154 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
1155 # encryption key of the source disk. Required if the source disk is
1156 # protected by a customer-supplied encryption key.
1157 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1158 # For example:
1159 #
1160 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1161 # key_region/cryptoKeys/key
1162 #
1163 # The fully-qualifed key name may be returned for resource GET requests. For
1164 # example:
1165 #
1166 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1167 # key_region/cryptoKeys/key
1168 # /cryptoKeyVersions/1
1169 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1170 # key. If absent, the Compute Engine default service account is used.
1171 # For example:
1172 #
1173 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1174 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1175 # encryption key, encoded in RFC
1176 # 4648 base64 to either encrypt or decrypt this resource. You can
1177 # provide either the rawKey or thersaEncryptedKey.
1178 # For example:
1179 #
1180 # &quot;rawKey&quot;:
1181 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1182 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1183 # customer-supplied encryption key to either encrypt or decrypt this
1184 # resource. You can provide either the rawKey or thersaEncryptedKey.
1185 # For example:
1186 #
1187 # &quot;rsaEncryptedKey&quot;:
1188 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1189 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1190 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1191 #
1192 # The key must meet the following requirements before you can provide it to
1193 # Compute Engine:
1194 #
1195 # 1. The key is wrapped using a RSA public key certificate provided by
1196 # Google.
1197 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1198 # encoding.
1199 #
1200 # Gets the RSA public key certificate provided by Google at:
1201 #
1202 #
1203 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1204 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1205 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1206 # encryption key that protects this resource.
1207 },
1208 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
1209 # snapshot.
1210 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
1211 # value may be used to determine whether the snapshot was taken from the
1212 # current or a previous instance of a given disk name.
1213 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
1214 # this as a partial or full URL to the resource. For example, the following
1215 # are valid values:
1216 #
1217 #
1218 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
1219 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
1220 # - zones/zone/instantSnapshots/instantSnapshot
1221 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
1222 # Snapshot.
1223 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1224 # For example:
1225 #
1226 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1227 # key_region/cryptoKeys/key
1228 #
1229 # The fully-qualifed key name may be returned for resource GET requests. For
1230 # example:
1231 #
1232 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1233 # key_region/cryptoKeys/key
1234 # /cryptoKeyVersions/1
1235 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1236 # key. If absent, the Compute Engine default service account is used.
1237 # For example:
1238 #
1239 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1240 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1241 # encryption key, encoded in RFC
1242 # 4648 base64 to either encrypt or decrypt this resource. You can
1243 # provide either the rawKey or thersaEncryptedKey.
1244 # For example:
1245 #
1246 # &quot;rawKey&quot;:
1247 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1248 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1249 # customer-supplied encryption key to either encrypt or decrypt this
1250 # resource. You can provide either the rawKey or thersaEncryptedKey.
1251 # For example:
1252 #
1253 # &quot;rsaEncryptedKey&quot;:
1254 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1255 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1256 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1257 #
1258 # The key must meet the following requirements before you can provide it to
1259 # Compute Engine:
1260 #
1261 # 1. The key is wrapped using a RSA public key certificate provided by
1262 # Google.
1263 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1264 # encoding.
1265 #
1266 # Gets the RSA public key certificate provided by Google at:
1267 #
1268 #
1269 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1270 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1271 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1272 # encryption key that protects this resource.
1273 },
1274 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
1275 # snapshot. This value identifies the exact instant snapshot that was used to
1276 # create this snapshot. For example, if you created the snapshot from an
1277 # instant snapshot that was later deleted and recreated under the same name,
1278 # the source instant snapshot ID would identify the exact instant snapshot
1279 # that was used.
1280 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
1281 # scheduled snapshot.
1282 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
1283 # scheduled snapshot.
1284 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
1285 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
1286 # share storage, this number is expected to change with snapshot
1287 # creation/deletion.
1288 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
1289 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
1290 # [Output Only] An indicator whether storageBytes is in a
1291 # stable state or it is being adjusted as a result of shared storage
1292 # reallocation. This status can either be unset, meaning the snapshot is
1293 # being created, or UP_TO_DATE, meaning the size of the snapshot
1294 # is up-to-date.
1295 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
1296 # multi-regional).
1297 &quot;A String&quot;,
1298 ],
1299 }</pre>
1300 </div>
1301
1302 <div class="method">
1303 <code class="details" id="getEffectiveRecycleBinRule">getEffectiveRecycleBinRule(project, snapshot, x__xgafv=None)</code>
1304 <pre>Returns the effective recycle bin rule for a snapshot by merging org and
1305 project level rules. If no rules are defined at org and project level, the
1306 standard default rule is returned.
1307
1308 Args:
1309 project: string, Project ID for this request. (required)
1310 snapshot: string, Name of the Snapshot resource to get the effective recycle bin rule for. (required)
1311 x__xgafv: string, V1 error format.
1312 Allowed values
1313 1 - v1 error format
1314 2 - v2 error format
1315
1316 Returns:
1317 An object of the form:
1318
1319 {
1320 &quot;retentionDurationDays&quot;: &quot;A String&quot;, # The retention duration of the snapshot in recycle bin.
1321 }</pre>
1322 </div>
1323
1324 <div class="method">
1325 <code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)</code>
1326 <pre>Gets the access control policy for a resource. May be empty if no such
1327 policy or resource exists.
1328
1329 Args:
1330 project: string, Project ID for this request. (required)
1331 resource: string, Name or id of the resource for this request. (required)
1332 optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
1333 x__xgafv: string, V1 error format.
1334 Allowed values
1335 1 - v1 error format
1336 2 - v2 error format
1337
1338 Returns:
1339 An object of the form:
1340
1341 { # An Identity and Access Management (IAM) policy, which specifies access
1342 # controls for Google Cloud resources.
1343 #
1344 #
1345 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1346 # `members`, or principals, to a single `role`. Principals can be user
1347 # accounts, service accounts, Google groups, and domains (such as G Suite). A
1348 # `role` is a named list of permissions; each `role` can be an IAM predefined
1349 # role or a user-created custom role.
1350 #
1351 # For some types of Google Cloud resources, a `binding` can also specify a
1352 # `condition`, which is a logical expression that allows access to a resource
1353 # only if the expression evaluates to `true`. A condition can add constraints
1354 # based on attributes of the request, the resource, or both. To learn which
1355 # resources support conditions in their IAM policies, see the
1356 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1357 #
1358 # **JSON example:**
1359 #
1360 # ```
1361 # {
1362 # &quot;bindings&quot;: [
1363 # {
1364 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1365 # &quot;members&quot;: [
1366 # &quot;user:[email protected]&quot;,
1367 # &quot;group:[email protected]&quot;,
1368 # &quot;domain:google.com&quot;,
1369 # &quot;serviceAccount:[email protected]&quot;
1370 # ]
1371 # },
1372 # {
1373 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1374 # &quot;members&quot;: [
1375 # &quot;user:[email protected]&quot;
1376 # ],
1377 # &quot;condition&quot;: {
1378 # &quot;title&quot;: &quot;expirable access&quot;,
1379 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1380 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
1381 # }
1382 # }
1383 # ],
1384 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1385 # &quot;version&quot;: 3
1386 # }
1387 # ```
1388 #
1389 # **YAML example:**
1390 #
1391 # ```
1392 # bindings:
1393 # - members:
1394 # - user:[email protected]
1395 # - group:[email protected]
1396 # - domain:google.com
1397 # - serviceAccount:[email protected]
1398 # role: roles/resourcemanager.organizationAdmin
1399 # - members:
1400 # - user:[email protected]
1401 # role: roles/resourcemanager.organizationViewer
1402 # condition:
1403 # title: expirable access
1404 # description: Does not grant access after Sep 2020
1405 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
1406 # etag: BwWWja0YfJA=
1407 # version: 3
1408 # ```
1409 #
1410 # For a description of IAM and its features, see the
1411 # [IAM documentation](https://cloud.google.com/iam/docs/).
1412 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1413 { # Specifies the audit configuration for a service.
1414 # The configuration determines which permission types are logged, and what
1415 # identities, if any, are exempted from logging.
1416 # An AuditConfig must have one or more AuditLogConfigs.
1417 #
1418 # If there are AuditConfigs for both `allServices` and a specific service,
1419 # the union of the two AuditConfigs is used for that service: the log_types
1420 # specified in each AuditConfig are enabled, and the exempted_members in each
1421 # AuditLogConfig are exempted.
1422 #
1423 # Example Policy with multiple AuditConfigs:
1424 #
1425 # {
1426 # &quot;audit_configs&quot;: [
1427 # {
1428 # &quot;service&quot;: &quot;allServices&quot;,
1429 # &quot;audit_log_configs&quot;: [
1430 # {
1431 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1432 # &quot;exempted_members&quot;: [
1433 # &quot;user:[email protected]&quot;
1434 # ]
1435 # },
1436 # {
1437 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1438 # },
1439 # {
1440 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
1441 # }
1442 # ]
1443 # },
1444 # {
1445 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
1446 # &quot;audit_log_configs&quot;: [
1447 # {
1448 # &quot;log_type&quot;: &quot;DATA_READ&quot;
1449 # },
1450 # {
1451 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1452 # &quot;exempted_members&quot;: [
1453 # &quot;user:[email protected]&quot;
1454 # ]
1455 # }
1456 # ]
1457 # }
1458 # ]
1459 # }
1460 #
1461 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1462 # logging. It also exempts `[email protected]` from DATA_READ logging, and
1463 # `[email protected]` from DATA_WRITE logging.
1464 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1465 { # Provides the configuration for logging a type of permissions.
1466 # Example:
1467 #
1468 # {
1469 # &quot;audit_log_configs&quot;: [
1470 # {
1471 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1472 # &quot;exempted_members&quot;: [
1473 # &quot;user:[email protected]&quot;
1474 # ]
1475 # },
1476 # {
1477 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
1478 # }
1479 # ]
1480 # }
1481 #
1482 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1483 # [email protected] from DATA_READ logging.
1484 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1485 # permission.
1486 # Follows the same format of Binding.members.
1487 &quot;A String&quot;,
1488 ],
1489 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
1490 },
1491 ],
1492 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1493 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1494 # `allServices` is a special value that covers all services.
1495 },
1496 ],
1497 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
1498 # may specify a `condition` that determines how and when the `bindings` are
1499 # applied. Each of the `bindings` must contain at least one principal.
1500 #
1501 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
1502 # of these principals can be Google groups. Each occurrence of a principal
1503 # counts towards these limits. For example, if the `bindings` grant 50
1504 # different roles to `user:[email protected]`, and not to any other
1505 # principal, then you can add another 1,450 principals to the `bindings` in
1506 # the `Policy`.
1507 { # Associates `members`, or principals, with a `role`.
1508 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1509 #
1510 # If the condition evaluates to `true`, then this binding applies to the
1511 # current request.
1512 #
1513 # If the condition evaluates to `false`, then this binding does not apply to
1514 # the current request. However, a different role binding might grant the same
1515 # role to one or more of the principals in this binding.
1516 #
1517 # To learn which resources support conditions in their IAM policies, see the
1518 # [IAM
1519 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1520 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1521 # are documented at https://github.com/google/cel-spec.
1522 #
1523 # Example (Comparison):
1524 #
1525 # title: &quot;Summary size limit&quot;
1526 # description: &quot;Determines if a summary is less than 100 chars&quot;
1527 # expression: &quot;document.summary.size() &lt; 100&quot;
1528 #
1529 # Example (Equality):
1530 #
1531 # title: &quot;Requestor is owner&quot;
1532 # description: &quot;Determines if requestor is the document owner&quot;
1533 # expression: &quot;document.owner == request.auth.claims.email&quot;
1534 #
1535 # Example (Logic):
1536 #
1537 # title: &quot;Public documents&quot;
1538 # description: &quot;Determine whether the document should be publicly visible&quot;
1539 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1540 #
1541 # Example (Data Manipulation):
1542 #
1543 # title: &quot;Notification string&quot;
1544 # description: &quot;Create a notification string with a timestamp.&quot;
1545 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1546 #
1547 # The exact variables and functions that may be referenced within an expression
1548 # are determined by the service that evaluates it. See the service
1549 # documentation for additional information.
1550 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1551 # describes the expression, e.g. when hovered over it in a UI.
1552 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1553 # syntax.
1554 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1555 # reporting, e.g. a file name and a position in the file.
1556 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1557 # its purpose. This can be used e.g. in UIs which allow to enter the
1558 # expression.
1559 },
1560 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
1561 # `members` can have the following values:
1562 #
1563 # * `allUsers`: A special identifier that represents anyone who is
1564 # on the internet; with or without a Google account.
1565 #
1566 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1567 # who is authenticated with a Google account or a service account.
1568 # Does not include identities that come from external identity providers
1569 # (IdPs) through identity federation.
1570 #
1571 # * `user:{emailid}`: An email address that represents a specific Google
1572 # account. For example, `[email protected]` .
1573 #
1574 #
1575 # * `serviceAccount:{emailid}`: An email address that represents a Google
1576 # service account. For example,
1577 # `[email protected]`.
1578 #
1579 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
1580 # identifier for a
1581 # [Kubernetes service
1582 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
1583 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
1584 #
1585 # * `group:{emailid}`: An email address that represents a Google group.
1586 # For example, `[email protected]`.
1587 #
1588 #
1589 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1590 # users of that domain. For example, `google.com` or `example.com`.
1591 #
1592 #
1593 #
1594 #
1595 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1596 # A single identity in a workforce identity pool.
1597 #
1598 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
1599 # All workforce identities in a group.
1600 #
1601 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1602 # All workforce identities with a specific attribute value.
1603 #
1604 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
1605 # All identities in a workforce identity pool.
1606 #
1607 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
1608 # A single identity in a workload identity pool.
1609 #
1610 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
1611 # A workload identity pool group.
1612 #
1613 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
1614 # All identities in a workload identity pool with a certain attribute.
1615 #
1616 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
1617 # All identities in a workload identity pool.
1618 #
1619 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1620 # identifier) representing a user that has been recently deleted. For
1621 # example, `[email protected]?uid=123456789012345678901`. If the user is
1622 # recovered, this value reverts to `user:{emailid}` and the recovered user
1623 # retains the role in the binding.
1624 #
1625 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1626 # unique identifier) representing a service account that has been recently
1627 # deleted. For example,
1628 # `[email protected]?uid=123456789012345678901`.
1629 # If the service account is undeleted, this value reverts to
1630 # `serviceAccount:{emailid}` and the undeleted service account retains the
1631 # role in the binding.
1632 #
1633 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1634 # identifier) representing a Google group that has been recently
1635 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
1636 # the group is recovered, this value reverts to `group:{emailid}` and the
1637 # recovered group retains the role in the binding.
1638 #
1639 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
1640 # Deleted single identity in a workforce identity pool. For example,
1641 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
1642 &quot;A String&quot;,
1643 ],
1644 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
1645 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1646 #
1647 # For an overview of the IAM roles and permissions, see the
1648 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
1649 # a list of the available pre-defined roles, see
1650 # [here](https://cloud.google.com/iam/docs/understanding-roles).
1651 },
1652 ],
1653 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1654 # prevent simultaneous updates of a policy from overwriting each other.
1655 # It is strongly suggested that systems make use of the `etag` in the
1656 # read-modify-write cycle to perform policy updates in order to avoid race
1657 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1658 # systems are expected to put that etag in the request to `setIamPolicy` to
1659 # ensure that their change will be applied to the same version of the policy.
1660 #
1661 # **Important:** If you use IAM Conditions, you must include the `etag` field
1662 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1663 # you to overwrite a version `3` policy with a version `1` policy, and all of
1664 # the conditions in the version `3` policy are lost.
1665 &quot;version&quot;: 42, # Specifies the format of the policy.
1666 #
1667 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1668 # are rejected.
1669 #
1670 # Any operation that affects conditional role bindings must specify version
1671 # `3`. This requirement applies to the following operations:
1672 #
1673 # * Getting a policy that includes a conditional role binding
1674 # * Adding a conditional role binding to a policy
1675 # * Changing a conditional role binding in a policy
1676 # * Removing any role binding, with or without a condition, from a policy
1677 # that includes conditions
1678 #
1679 # **Important:** If you use IAM Conditions, you must include the `etag` field
1680 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1681 # you to overwrite a version `3` policy with a version `1` policy, and all of
1682 # the conditions in the version `3` policy are lost.
1683 #
1684 # If a policy does not include any conditions, operations on that policy may
1685 # specify any valid version or leave the field unset.
1686 #
1687 # To learn which resources support conditions in their IAM policies, see the
1688 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
1689 }</pre>
1690 </div>
1691
1692 <div class="method">
1693 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>
1694 <pre>Creates a snapshot in the specified project using the data included
1695 in the request. For regular snapshot creation, consider using this method
1696 instead of disks.createSnapshot,
1697 as this method supports more features, such as creating snapshots in a
1698 project different from the source disk project.
1699
1700 Args:
1701 project: string, Project ID for this request. (required)
1702 body: object, The request body.
1703 The object takes the form of:
1704
1705 { # Represents a Persistent Disk Snapshot resource.
1706 #
1707 # You can use snapshots to back up data on a regular interval. For more
1708 # information, read Creating
1709 # persistent disk snapshots.
1710 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
1711 # ARM64 or X86_64.
1712 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
1713 # applying resource policy on the target disk.
1714 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
1715 # specified name. The chain name must be 1-63 characters long and comply
1716 # with RFC1035. This is an uncommon option only for advanced service
1717 # owners who needs to create separate snapshot chains, for example,
1718 # for chargeback tracking. When you describe your snapshot resource, this
1719 # field is visible only if it has a non-empty value.
1720 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
1721 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
1722 # text format.
1723 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
1724 # create the resource.
1725 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
1726 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
1727 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
1728 # [Output Only]: This field is not set by user, but from source disk.
1729 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
1730 # informing the OS to prepare for the snapshot process.
1731 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
1732 # Applicable only for bootable images. Read
1733 # Enabling guest operating system features to see a list of available
1734 # options.
1735 { # Guest OS features.
1736 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
1737 # separate values. Set to one or more of the following values:
1738 #
1739 # - VIRTIO_SCSI_MULTIQUEUE
1740 # - WINDOWS
1741 # - MULTI_IP_SUBNET
1742 # - UEFI_COMPATIBLE
1743 # - GVNIC
1744 # - SEV_CAPABLE
1745 # - SUSPEND_RESUME_COMPATIBLE
1746 # - SEV_LIVE_MIGRATABLE_V2
1747 # - SEV_SNP_CAPABLE
1748 # - TDX_CAPABLE
1749 # - IDPF
1750 # - SNP_SVSM_CAPABLE
1751 # - CCA_CAPABLE
1752 #
1753 #
1754 # For more information, see
1755 # Enabling guest operating system features.
1756 },
1757 ],
1758 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
1759 # defined by the server.
1760 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
1761 # for Snapshot resources.
1762 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
1763 # essentially a hash of the labels set used for optimistic locking. The
1764 # fingerprint is initially generated by Compute Engine and changes after
1765 # every request to modify or update labels. You must always provide an
1766 # up-to-date fingerprint hash in order to update or change labels,
1767 # otherwise the request will fail with error412 conditionNotMet.
1768 #
1769 # To see the latest fingerprint, make a get() request to
1770 # retrieve a snapshot.
1771 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
1772 # the setLabels method.
1773 # Label values may be empty.
1774 &quot;a_key&quot;: &quot;A String&quot;,
1775 },
1776 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
1777 # to this snapshot.
1778 &quot;A String&quot;,
1779 ],
1780 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
1781 # snapshot. This can be because the original image had licenses attached
1782 # (such as a Windows image).
1783 &quot;A String&quot;,
1784 ],
1785 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
1786 # resources.
1787 # This field is for use by internal tools that use the public API.
1788 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
1789 # automatically.
1790 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
1791 # The name must be 1-63 characters long, and comply withRFC1035.
1792 # Specifically, the name must be 1-63 characters long and match the regular
1793 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
1794 # character must be a lowercase letter, and all following characters must be
1795 # a dash, lowercase letter, or digit, except the last character, which cannot
1796 # be a dash.
1797 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
1798 # as part of resource payload.
1799 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
1800 # the same definition as resource
1801 # manager tags. Keys and values can be either in numeric format,
1802 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
1803 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
1804 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
1805 # PATCH) when empty.
1806 &quot;a_key&quot;: &quot;A String&quot;,
1807 },
1808 },
1809 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
1810 # for regional snapshots.
1811 &quot;resourceStatus&quot;: { # Output only. [Output only] ResourceStatus of the Snapshot resource
1812 &quot;scheduledDeletionTime&quot;: &quot;A String&quot;, # Output only. [Output only] Scheduled deletion time of the snapshot. The snapshot will
1813 # be deleted by the at any point within one hour after the deletion time.
1814 },
1815 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
1816 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
1817 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
1818 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
1819 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
1820 # encryption key.
1821 #
1822 # After you encrypt a snapshot using a customer-supplied key, you must
1823 # provide the same key if you use the snapshot later. For example, you must
1824 # provide the encryption key when you create a disk from the encrypted
1825 # snapshot in a future request.
1826 #
1827 # Customer-supplied encryption keys do not protect access to metadata
1828 # of the snapshot.
1829 #
1830 # If you do not provide an encryption key when creating the snapshot, then
1831 # the snapshot will be encrypted using an automatically generated key and you
1832 # do not need to provide a key to use the snapshot later.
1833 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1834 # For example:
1835 #
1836 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1837 # key_region/cryptoKeys/key
1838 #
1839 # The fully-qualifed key name may be returned for resource GET requests. For
1840 # example:
1841 #
1842 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1843 # key_region/cryptoKeys/key
1844 # /cryptoKeyVersions/1
1845 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1846 # key. If absent, the Compute Engine default service account is used.
1847 # For example:
1848 #
1849 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1850 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1851 # encryption key, encoded in RFC
1852 # 4648 base64 to either encrypt or decrypt this resource. You can
1853 # provide either the rawKey or thersaEncryptedKey.
1854 # For example:
1855 #
1856 # &quot;rawKey&quot;:
1857 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1858 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1859 # customer-supplied encryption key to either encrypt or decrypt this
1860 # resource. You can provide either the rawKey or thersaEncryptedKey.
1861 # For example:
1862 #
1863 # &quot;rsaEncryptedKey&quot;:
1864 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1865 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1866 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1867 #
1868 # The key must meet the following requirements before you can provide it to
1869 # Compute Engine:
1870 #
1871 # 1. The key is wrapped using a RSA public key certificate provided by
1872 # Google.
1873 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1874 # encoding.
1875 #
1876 # Gets the RSA public key certificate provided by Google at:
1877 #
1878 #
1879 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1880 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1881 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1882 # encryption key that protects this resource.
1883 },
1884 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
1885 # belongs to. The usage of snapshot group feature is restricted.
1886 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
1887 # of snapshot group feature is restricted.
1888 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
1889 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
1890 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
1891 # encryption key of the source disk. Required if the source disk is
1892 # protected by a customer-supplied encryption key.
1893 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1894 # For example:
1895 #
1896 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1897 # key_region/cryptoKeys/key
1898 #
1899 # The fully-qualifed key name may be returned for resource GET requests. For
1900 # example:
1901 #
1902 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1903 # key_region/cryptoKeys/key
1904 # /cryptoKeyVersions/1
1905 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1906 # key. If absent, the Compute Engine default service account is used.
1907 # For example:
1908 #
1909 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1910 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1911 # encryption key, encoded in RFC
1912 # 4648 base64 to either encrypt or decrypt this resource. You can
1913 # provide either the rawKey or thersaEncryptedKey.
1914 # For example:
1915 #
1916 # &quot;rawKey&quot;:
1917 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1918 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1919 # customer-supplied encryption key to either encrypt or decrypt this
1920 # resource. You can provide either the rawKey or thersaEncryptedKey.
1921 # For example:
1922 #
1923 # &quot;rsaEncryptedKey&quot;:
1924 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1925 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1926 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1927 #
1928 # The key must meet the following requirements before you can provide it to
1929 # Compute Engine:
1930 #
1931 # 1. The key is wrapped using a RSA public key certificate provided by
1932 # Google.
1933 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
1934 # encoding.
1935 #
1936 # Gets the RSA public key certificate provided by Google at:
1937 #
1938 #
1939 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
1940 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
1941 # 4648 base64 encoded SHA-256 hash of the customer-supplied
1942 # encryption key that protects this resource.
1943 },
1944 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
1945 # snapshot.
1946 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
1947 # value may be used to determine whether the snapshot was taken from the
1948 # current or a previous instance of a given disk name.
1949 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
1950 # this as a partial or full URL to the resource. For example, the following
1951 # are valid values:
1952 #
1953 #
1954 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
1955 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
1956 # - zones/zone/instantSnapshots/instantSnapshot
1957 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
1958 # Snapshot.
1959 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
1960 # For example:
1961 #
1962 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1963 # key_region/cryptoKeys/key
1964 #
1965 # The fully-qualifed key name may be returned for resource GET requests. For
1966 # example:
1967 #
1968 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
1969 # key_region/cryptoKeys/key
1970 # /cryptoKeyVersions/1
1971 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
1972 # key. If absent, the Compute Engine default service account is used.
1973 # For example:
1974 #
1975 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
1976 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
1977 # encryption key, encoded in RFC
1978 # 4648 base64 to either encrypt or decrypt this resource. You can
1979 # provide either the rawKey or thersaEncryptedKey.
1980 # For example:
1981 #
1982 # &quot;rawKey&quot;:
1983 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
1984 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
1985 # customer-supplied encryption key to either encrypt or decrypt this
1986 # resource. You can provide either the rawKey or thersaEncryptedKey.
1987 # For example:
1988 #
1989 # &quot;rsaEncryptedKey&quot;:
1990 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
1991 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
1992 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
1993 #
1994 # The key must meet the following requirements before you can provide it to
1995 # Compute Engine:
1996 #
1997 # 1. The key is wrapped using a RSA public key certificate provided by
1998 # Google.
1999 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2000 # encoding.
2001 #
2002 # Gets the RSA public key certificate provided by Google at:
2003 #
2004 #
2005 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2006 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2007 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2008 # encryption key that protects this resource.
2009 },
2010 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
2011 # snapshot. This value identifies the exact instant snapshot that was used to
2012 # create this snapshot. For example, if you created the snapshot from an
2013 # instant snapshot that was later deleted and recreated under the same name,
2014 # the source instant snapshot ID would identify the exact instant snapshot
2015 # that was used.
2016 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
2017 # scheduled snapshot.
2018 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
2019 # scheduled snapshot.
2020 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
2021 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
2022 # share storage, this number is expected to change with snapshot
2023 # creation/deletion.
2024 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
2025 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
2026 # [Output Only] An indicator whether storageBytes is in a
2027 # stable state or it is being adjusted as a result of shared storage
2028 # reallocation. This status can either be unset, meaning the snapshot is
2029 # being created, or UP_TO_DATE, meaning the size of the snapshot
2030 # is up-to-date.
2031 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
2032 # multi-regional).
2033 &quot;A String&quot;,
2034 ],
2035 }
2036
2037 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
2038 that if you must retry your request, the server will know to ignore the
2039 request if it has already been completed.
2040
2041 For example, consider a situation where you make an initial request and
2042 the request times out. If you make the request again with the same
2043 request ID, the server can check if original operation with the same
2044 request ID was received, and if so, will ignore the second request. This
2045 prevents clients from accidentally creating duplicate commitments.
2046
2047 The request ID must be
2048 a valid UUID with the exception that zero UUID is not supported
2049 (00000000-0000-0000-0000-000000000000).
2050 x__xgafv: string, V1 error format.
2051 Allowed values
2052 1 - v1 error format
2053 2 - v2 error format
2054
2055 Returns:
2056 An object of the form:
2057
2058 { # Represents an Operation resource.
2059 #
2060 # Google Compute Engine has three Operation resources:
2061 #
2062 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
2063 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
2064 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
2065 #
2066 # You can use an operation resource to manage asynchronous API requests.
2067 # For more information, readHandling
2068 # API responses.
2069 #
2070 # Operations can be global, regional or zonal.
2071 #
2072 # - For global operations, use the `globalOperations`
2073 # resource.
2074 # - For regional operations, use the
2075 # `regionOperations` resource.
2076 # - For zonal operations, use
2077 # the `zoneOperations` resource.
2078 #
2079 #
2080 #
2081 # For more information, read
2082 # Global, Regional, and Zonal Resources.
2083 #
2084 # Note that completed Operation resources have a limited
2085 # retention period.
2086 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
2087 # Not present otherwise.
2088 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
2089 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
2090 # set when the operation is created.
2091 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
2092 # text format.
2093 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
2094 # this field will be populated.
2095 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
2096 # operation.
2097 {
2098 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
2099 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
2100 # details. There is a set of defined message types to use for providing
2101 # details.The syntax depends on the error code. For example,
2102 # QuotaExceededInfo will have details when the error code is
2103 # QUOTA_EXCEEDED.
2104 {
2105 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
2106 #
2107 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
2108 # is not enabled:
2109 #
2110 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
2111 # &quot;domain&quot;: &quot;googleapis.com&quot;
2112 # &quot;metadata&quot;: {
2113 # &quot;resource&quot;: &quot;projects/123&quot;,
2114 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
2115 # }
2116 # }
2117 #
2118 # This response indicates that the pubsub.googleapis.com API is not enabled.
2119 #
2120 # Example of an error that is returned when attempting to create a Spanner
2121 # instance in a region that is out of stock:
2122 #
2123 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
2124 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
2125 # &quot;metadata&quot;: {
2126 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
2127 # }
2128 # }
2129 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
2130 # is typically the registered service name of the tool or product that
2131 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
2132 # generated by some common infrastructure, the error domain must be a
2133 # globally unique value that identifies the infrastructure. For Google API
2134 # infrastructure, the error domain is &quot;googleapis.com&quot;.
2135 &quot;metadatas&quot;: { # Additional structured details about this error.
2136 #
2137 # Keys must match a regular expression of `a-z+` but should
2138 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
2139 # length. When identifying the current value of an exceeded limit, the units
2140 # should be contained in the key, not the value. For example, rather than
2141 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
2142 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
2143 # instances that can be created in a single (batch) request.
2144 &quot;a_key&quot;: &quot;A String&quot;,
2145 },
2146 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
2147 # proximate cause of the error. Error reasons are unique within a particular
2148 # domain of errors. This should be at most 63 characters and match a
2149 # regular expression of `A-Z+[A-Z0-9]`, which represents
2150 # UPPER_SNAKE_CASE.
2151 },
2152 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
2153 #
2154 # For example, if a quota check failed with an error indicating the calling
2155 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
2156 # directly to the right place in the developer console to flip the bit.
2157 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
2158 { # Describes a URL link.
2159 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
2160 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
2161 },
2162 ],
2163 },
2164 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
2165 # which can be attached to an RPC error.
2166 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
2167 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
2168 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
2169 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
2170 },
2171 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
2172 &quot;dimensions&quot;: { # The map holding related quota dimensions.
2173 &quot;a_key&quot;: &quot;A String&quot;,
2174 },
2175 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
2176 # type or metric.
2177 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
2178 # or metric.
2179 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
2180 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
2181 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
2182 },
2183 },
2184 ],
2185 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
2186 # This property is optional.
2187 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
2188 },
2189 ],
2190 },
2191 &quot;getVersionOperationMetadata&quot;: {
2192 &quot;inlineSbomInfo&quot;: {
2193 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
2194 # appropriate identifiers.
2195 &quot;a_key&quot;: &quot;A String&quot;,
2196 },
2197 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
2198 # identifiers.
2199 &quot;a_key&quot;: &quot;A String&quot;,
2200 },
2201 },
2202 },
2203 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
2204 # message that was returned, such as `NOT FOUND`.
2205 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
2206 # status code that was returned. For example, a `404` means the
2207 # resource was not found.
2208 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
2209 # defined by the server.
2210 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
2211 # This value is inRFC3339
2212 # text format.
2213 &quot;instancesBulkInsertOperationMetadata&quot;: {
2214 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
2215 # Example key: zones/us-central1-a
2216 &quot;a_key&quot;: {
2217 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
2218 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
2219 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
2220 # error.
2221 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
2222 # if the flow is rolling forward or rolling back.
2223 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
2224 },
2225 },
2226 },
2227 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
2228 # Operation resources.
2229 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
2230 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
2231 # group of operations results from a `bulkInsert` API request.
2232 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
2233 # `update`, or `delete`, and so on.
2234 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
2235 # There is no requirement that this be linear or support any granularity of
2236 # operations. This should not be used to guess when the operation will be
2237 # complete. This number should monotonically increase as the operation
2238 # progresses.
2239 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
2240 # applicable when performing regional operations.
2241 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
2242 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
2243 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
2244 # this field will contain information on all underlying zonal actions and
2245 # their state.
2246 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
2247 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
2248 # Example key: zones/us-central1-a
2249 &quot;a_key&quot;: {
2250 &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
2251 # populated.
2252 # different programming environments, including REST APIs and RPC APIs. It is
2253 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
2254 # three pieces of data: error code, error message, and error details.
2255 #
2256 # You can find out more about this error model and how to work with it in the
2257 # [API Design Guide](https://cloud.google.com/apis/design/errors).
2258 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
2259 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
2260 # message types for APIs to use.
2261 {
2262 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2263 },
2264 ],
2265 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
2266 # user-facing error message should be localized and sent in the
2267 # google.rpc.Status.details field, or localized by the client.
2268 },
2269 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
2270 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
2271 },
2272 },
2273 },
2274 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
2275 # This value is inRFC3339
2276 # text format.
2277 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
2278 # following:
2279 # `PENDING`, `RUNNING`, or `DONE`.
2280 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
2281 # operation.
2282 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
2283 # of the target resource.
2284 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
2285 # operations related to creating a snapshot, this points to the disk
2286 # that the snapshot was created from.
2287 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
2288 # `[email protected]` or
2289 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
2290 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
2291 # operation, this field will be populated.
2292 {
2293 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2294 # Engine returns NO_RESULTS_ON_PAGE if there
2295 # are no results in the response.
2296 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2297 # value format. For example:
2298 #
2299 # &quot;data&quot;: [
2300 # {
2301 # &quot;key&quot;: &quot;scope&quot;,
2302 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2303 # }
2304 {
2305 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2306 # returned. For example, for warnings where there are no results in a list
2307 # request for a particular zone, this key might be scope and
2308 # the key value might be the zone name. Other examples might be a key
2309 # indicating a deprecated resource and a suggested replacement, or a
2310 # warning about invalid network settings (for example, if an instance
2311 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2312 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2313 },
2314 ],
2315 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2316 },
2317 ],
2318 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
2319 # applicable when performing per-zone operations.
2320 }</pre>
2321 </div>
2322
2323 <div class="method">
2324 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
2325 <pre>Retrieves the list of Snapshot resources contained within
2326 the specified project.
2327
2328 Args:
2329 project: string, Project ID for this request. (required)
2330 filter: string, A filter expression that filters resources listed in the response. Most
2331 Compute resources support two types of filter expressions:
2332 expressions that support regular expressions and expressions that follow
2333 API improvement proposal AIP-160.
2334 These two types of filter expressions cannot be mixed in one request.
2335
2336 If you want to use AIP-160, your expression must specify the field name, an
2337 operator, and the value that you want to use for filtering. The value
2338 must be a string, a number, or a boolean. The operator
2339 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
2340
2341 For example, if you are filtering Compute Engine instances, you can
2342 exclude instances named `example-instance` by specifying
2343 `name != example-instance`.
2344
2345 The `:*` comparison can be used to test whether a key has been defined.
2346 For example, to find all objects with `owner` label use:
2347 ```
2348 labels.owner:*
2349 ```
2350
2351 You can also filter nested fields. For example, you could specify
2352 `scheduling.automaticRestart = false` to include instances only
2353 if they are not scheduled for automatic restarts. You can use filtering
2354 on nested fields to filter based onresource labels.
2355
2356 To filter on multiple expressions, provide each separate expression within
2357 parentheses. For example:
2358 ```
2359 (scheduling.automaticRestart = true)
2360 (cpuPlatform = &quot;Intel Skylake&quot;)
2361 ```
2362 By default, each expression is an `AND` expression. However, you
2363 can include `AND` and `OR` expressions explicitly.
2364 For example:
2365 ```
2366 (cpuPlatform = &quot;Intel Skylake&quot;) OR
2367 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
2368 (scheduling.automaticRestart = true)
2369 ```
2370
2371 If you want to use a regular expression, use the `eq` (equal) or `ne`
2372 (not equal) operator against a single un-parenthesized expression with or
2373 without quotes or against multiple parenthesized expressions. Examples:
2374
2375 `fieldname eq unquoted literal`
2376 `fieldname eq &#x27;single quoted literal&#x27;`
2377 `fieldname eq &quot;double quoted literal&quot;`
2378 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
2379
2380 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
2381 The literal value must match the entire field.
2382
2383 For example, to filter for instances that do not end with name &quot;instance&quot;,
2384 you would use `name ne .*instance`.
2385
2386 You cannot combine constraints on multiple fields using regular
2387 expressions.
2388 maxResults: integer, The maximum number of results per page that should be returned.
2389 If the number of available results is larger than `maxResults`,
2390 Compute Engine returns a `nextPageToken` that can be used to get
2391 the next page of results in subsequent list requests. Acceptable values are
2392 `0` to `500`, inclusive. (Default: `500`)
2393 orderBy: string, Sorts list results by a certain order. By default, results
2394 are returned in alphanumerical order based on the resource name.
2395
2396 You can also sort results in descending order based on the creation
2397 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
2398 results based on the `creationTimestamp` field in
2399 reverse chronological order (newest result first). Use this to sort
2400 resources like operations so that the newest operation is returned first.
2401
2402 Currently, only sorting by `name` or
2403 `creationTimestamp desc` is supported.
2404 pageToken: string, Specifies a page token to use. Set `pageToken` to the
2405 `nextPageToken` returned by a previous list request to get
2406 the next page of results.
2407 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
2408 of failure. The default value is false.
2409
2410 For example, when partial success behavior is enabled, aggregatedList for a
2411 single zone scope either returns all resources in the zone or no resources,
2412 with an error code.
2413 x__xgafv: string, V1 error format.
2414 Allowed values
2415 1 - v1 error format
2416 2 - v2 error format
2417
2418 Returns:
2419 An object of the form:
2420
2421 { # Contains a list of Snapshot resources.
2422 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
2423 &quot;items&quot;: [ # A list of Snapshot resources.
2424 { # Represents a Persistent Disk Snapshot resource.
2425 #
2426 # You can use snapshots to back up data on a regular interval. For more
2427 # information, read Creating
2428 # persistent disk snapshots.
2429 &quot;architecture&quot;: &quot;A String&quot;, # Output only. [Output Only] The architecture of the snapshot. Valid values are
2430 # ARM64 or X86_64.
2431 &quot;autoCreated&quot;: True or False, # Output only. [Output Only] Set to true if snapshots are automatically created by
2432 # applying resource policy on the target disk.
2433 &quot;chainName&quot;: &quot;A String&quot;, # Creates the new snapshot in the snapshot chain labeled with the
2434 # specified name. The chain name must be 1-63 characters long and comply
2435 # with RFC1035. This is an uncommon option only for advanced service
2436 # owners who needs to create separate snapshot chains, for example,
2437 # for chargeback tracking. When you describe your snapshot resource, this
2438 # field is visible only if it has a non-empty value.
2439 &quot;creationSizeBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Size in bytes of the snapshot at creation time.
2440 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp inRFC3339
2441 # text format.
2442 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you
2443 # create the resource.
2444 &quot;diskSizeGb&quot;: &quot;A String&quot;, # Output only. [Output Only] Size of the source disk, specified in GB.
2445 &quot;downloadBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
2446 &quot;enableConfidentialCompute&quot;: True or False, # Output only. Whether this snapshot is created from a confidential compute mode disk.
2447 # [Output Only]: This field is not set by user, but from source disk.
2448 &quot;guestFlush&quot;: True or False, # [Input Only] Whether to attempt an application consistent snapshot by
2449 # informing the OS to prepare for the snapshot process.
2450 &quot;guestOsFeatures&quot;: [ # Output only. [Output Only] A list of features to enable on the guest operating system.
2451 # Applicable only for bootable images. Read
2452 # Enabling guest operating system features to see a list of available
2453 # options.
2454 { # Guest OS features.
2455 &quot;type&quot;: &quot;A String&quot;, # The ID of a supported feature. To add multiple values, use commas to
2456 # separate values. Set to one or more of the following values:
2457 #
2458 # - VIRTIO_SCSI_MULTIQUEUE
2459 # - WINDOWS
2460 # - MULTI_IP_SUBNET
2461 # - UEFI_COMPATIBLE
2462 # - GVNIC
2463 # - SEV_CAPABLE
2464 # - SUSPEND_RESUME_COMPATIBLE
2465 # - SEV_LIVE_MIGRATABLE_V2
2466 # - SEV_SNP_CAPABLE
2467 # - TDX_CAPABLE
2468 # - IDPF
2469 # - SNP_SVSM_CAPABLE
2470 # - CCA_CAPABLE
2471 #
2472 #
2473 # For more information, see
2474 # Enabling guest operating system features.
2475 },
2476 ],
2477 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
2478 # defined by the server.
2479 &quot;kind&quot;: &quot;compute#snapshot&quot;, # Output only. [Output Only] Type of the resource. Always compute#snapshot
2480 # for Snapshot resources.
2481 &quot;labelFingerprint&quot;: &quot;A String&quot;, # A fingerprint for the labels being applied to this snapshot, which is
2482 # essentially a hash of the labels set used for optimistic locking. The
2483 # fingerprint is initially generated by Compute Engine and changes after
2484 # every request to modify or update labels. You must always provide an
2485 # up-to-date fingerprint hash in order to update or change labels,
2486 # otherwise the request will fail with error412 conditionNotMet.
2487 #
2488 # To see the latest fingerprint, make a get() request to
2489 # retrieve a snapshot.
2490 &quot;labels&quot;: { # Labels to apply to this snapshot. These can be later modified by
2491 # the setLabels method.
2492 # Label values may be empty.
2493 &quot;a_key&quot;: &quot;A String&quot;,
2494 },
2495 &quot;licenseCodes&quot;: [ # Output only. [Output Only] Integer license codes indicating which licenses are attached
2496 # to this snapshot.
2497 &quot;A String&quot;,
2498 ],
2499 &quot;licenses&quot;: [ # Output only. [Output Only] A list of public visible licenses that apply to this
2500 # snapshot. This can be because the original image had licenses attached
2501 # (such as a Windows image).
2502 &quot;A String&quot;,
2503 ],
2504 &quot;locationHint&quot;: &quot;A String&quot;, # An opaque location hint used to place the snapshot close to other
2505 # resources.
2506 # This field is for use by internal tools that use the public API.
2507 &quot;maxRetentionDays&quot;: 42, # Number of days the snapshot should be retained before being deleted
2508 # automatically.
2509 &quot;name&quot;: &quot;A String&quot;, # Name of the resource; provided by the client when the resource is created.
2510 # The name must be 1-63 characters long, and comply withRFC1035.
2511 # Specifically, the name must be 1-63 characters long and match the regular
2512 # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
2513 # character must be a lowercase letter, and all following characters must be
2514 # a dash, lowercase letter, or digit, except the last character, which cannot
2515 # be a dash.
2516 &quot;params&quot;: { # Additional snapshot params. # Input only. [Input Only] Additional params passed with the request, but not persisted
2517 # as part of resource payload.
2518 &quot;resourceManagerTags&quot;: { # Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have
2519 # the same definition as resource
2520 # manager tags. Keys and values can be either in numeric format,
2521 # such as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in
2522 # namespaced format such as `{org_id|project_id}/{tag_key_short_name}` and
2523 # `{tag_value_short_name}`. The field is ignored (both PUT &amp;
2524 # PATCH) when empty.
2525 &quot;a_key&quot;: &quot;A String&quot;,
2526 },
2527 },
2528 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the region where the snapshot resides. Only applicable
2529 # for regional snapshots.
2530 &quot;resourceStatus&quot;: { # Output only. [Output only] ResourceStatus of the Snapshot resource
2531 &quot;scheduledDeletionTime&quot;: &quot;A String&quot;, # Output only. [Output only] Scheduled deletion time of the snapshot. The snapshot will
2532 # be deleted by the at any point within one hour after the deletion time.
2533 },
2534 &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
2535 &quot;satisfiesPzs&quot;: True or False, # Output only. [Output Only] Reserved for future use.
2536 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
2537 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource&#x27;s resource id.
2538 &quot;snapshotEncryptionKey&quot;: { # Encrypts the snapshot using acustomer-supplied
2539 # encryption key.
2540 #
2541 # After you encrypt a snapshot using a customer-supplied key, you must
2542 # provide the same key if you use the snapshot later. For example, you must
2543 # provide the encryption key when you create a disk from the encrypted
2544 # snapshot in a future request.
2545 #
2546 # Customer-supplied encryption keys do not protect access to metadata
2547 # of the snapshot.
2548 #
2549 # If you do not provide an encryption key when creating the snapshot, then
2550 # the snapshot will be encrypted using an automatically generated key and you
2551 # do not need to provide a key to use the snapshot later.
2552 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2553 # For example:
2554 #
2555 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2556 # key_region/cryptoKeys/key
2557 #
2558 # The fully-qualifed key name may be returned for resource GET requests. For
2559 # example:
2560 #
2561 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2562 # key_region/cryptoKeys/key
2563 # /cryptoKeyVersions/1
2564 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2565 # key. If absent, the Compute Engine default service account is used.
2566 # For example:
2567 #
2568 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2569 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2570 # encryption key, encoded in RFC
2571 # 4648 base64 to either encrypt or decrypt this resource. You can
2572 # provide either the rawKey or thersaEncryptedKey.
2573 # For example:
2574 #
2575 # &quot;rawKey&quot;:
2576 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2577 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2578 # customer-supplied encryption key to either encrypt or decrypt this
2579 # resource. You can provide either the rawKey or thersaEncryptedKey.
2580 # For example:
2581 #
2582 # &quot;rsaEncryptedKey&quot;:
2583 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2584 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2585 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2586 #
2587 # The key must meet the following requirements before you can provide it to
2588 # Compute Engine:
2589 #
2590 # 1. The key is wrapped using a RSA public key certificate provided by
2591 # Google.
2592 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2593 # encoding.
2594 #
2595 # Gets the RSA public key certificate provided by Google at:
2596 #
2597 #
2598 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2599 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2600 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2601 # encryption key that protects this resource.
2602 },
2603 &quot;snapshotGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the snapshot group that this snapshot
2604 # belongs to. The usage of snapshot group feature is restricted.
2605 &quot;snapshotGroupName&quot;: &quot;A String&quot;, # Output only. [Output only] The snapshot group that this snapshot belongs to. The usage
2606 # of snapshot group feature is restricted.
2607 &quot;snapshotType&quot;: &quot;A String&quot;, # Indicates the type of the snapshot.
2608 &quot;sourceDisk&quot;: &quot;A String&quot;, # The source disk used to create this snapshot.
2609 &quot;sourceDiskEncryptionKey&quot;: { # The customer-supplied
2610 # encryption key of the source disk. Required if the source disk is
2611 # protected by a customer-supplied encryption key.
2612 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2613 # For example:
2614 #
2615 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2616 # key_region/cryptoKeys/key
2617 #
2618 # The fully-qualifed key name may be returned for resource GET requests. For
2619 # example:
2620 #
2621 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2622 # key_region/cryptoKeys/key
2623 # /cryptoKeyVersions/1
2624 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2625 # key. If absent, the Compute Engine default service account is used.
2626 # For example:
2627 #
2628 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2629 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2630 # encryption key, encoded in RFC
2631 # 4648 base64 to either encrypt or decrypt this resource. You can
2632 # provide either the rawKey or thersaEncryptedKey.
2633 # For example:
2634 #
2635 # &quot;rawKey&quot;:
2636 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2637 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2638 # customer-supplied encryption key to either encrypt or decrypt this
2639 # resource. You can provide either the rawKey or thersaEncryptedKey.
2640 # For example:
2641 #
2642 # &quot;rsaEncryptedKey&quot;:
2643 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2644 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2645 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2646 #
2647 # The key must meet the following requirements before you can provide it to
2648 # Compute Engine:
2649 #
2650 # 1. The key is wrapped using a RSA public key certificate provided by
2651 # Google.
2652 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2653 # encoding.
2654 #
2655 # Gets the RSA public key certificate provided by Google at:
2656 #
2657 #
2658 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2659 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2660 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2661 # encryption key that protects this resource.
2662 },
2663 &quot;sourceDiskForRecoveryCheckpoint&quot;: &quot;A String&quot;, # The source disk whose recovery checkpoint will be used to create this
2664 # snapshot.
2665 &quot;sourceDiskId&quot;: &quot;A String&quot;, # Output only. [Output Only] The ID value of the disk used to create this snapshot. This
2666 # value may be used to determine whether the snapshot was taken from the
2667 # current or a previous instance of a given disk name.
2668 &quot;sourceInstantSnapshot&quot;: &quot;A String&quot;, # The source instant snapshot used to create this snapshot. You can provide
2669 # this as a partial or full URL to the resource. For example, the following
2670 # are valid values:
2671 #
2672 #
2673 # - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot
2674 # - projects/project/zones/zone/instantSnapshots/instantSnapshot
2675 # - zones/zone/instantSnapshots/instantSnapshot
2676 &quot;sourceInstantSnapshotEncryptionKey&quot;: { # Customer provided encryption key when creating Snapshot from Instant
2677 # Snapshot.
2678 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The name of the encryption key that is stored in Google Cloud KMS.
2679 # For example:
2680 #
2681 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2682 # key_region/cryptoKeys/key
2683 #
2684 # The fully-qualifed key name may be returned for resource GET requests. For
2685 # example:
2686 #
2687 # &quot;kmsKeyName&quot;: &quot;projects/kms_project_id/locations/region/keyRings/
2688 # key_region/cryptoKeys/key
2689 # /cryptoKeyVersions/1
2690 &quot;kmsKeyServiceAccount&quot;: &quot;A String&quot;, # The service account being used for the encryption request for the given KMS
2691 # key. If absent, the Compute Engine default service account is used.
2692 # For example:
2693 #
2694 # &quot;kmsKeyServiceAccount&quot;: &quot;name@project_id.iam.gserviceaccount.com/
2695 &quot;rawKey&quot;: &quot;A String&quot;, # Specifies a 256-bit customer-supplied
2696 # encryption key, encoded in RFC
2697 # 4648 base64 to either encrypt or decrypt this resource. You can
2698 # provide either the rawKey or thersaEncryptedKey.
2699 # For example:
2700 #
2701 # &quot;rawKey&quot;:
2702 # &quot;SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=&quot;
2703 &quot;rsaEncryptedKey&quot;: &quot;A String&quot;, # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
2704 # customer-supplied encryption key to either encrypt or decrypt this
2705 # resource. You can provide either the rawKey or thersaEncryptedKey.
2706 # For example:
2707 #
2708 # &quot;rsaEncryptedKey&quot;:
2709 # &quot;ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
2710 # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
2711 # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==&quot;
2712 #
2713 # The key must meet the following requirements before you can provide it to
2714 # Compute Engine:
2715 #
2716 # 1. The key is wrapped using a RSA public key certificate provided by
2717 # Google.
2718 # 2. After being wrapped, the key must be encoded in RFC 4648 base64
2719 # encoding.
2720 #
2721 # Gets the RSA public key certificate provided by Google at:
2722 #
2723 #
2724 # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
2725 &quot;sha256&quot;: &quot;A String&quot;, # [Output only] TheRFC
2726 # 4648 base64 encoded SHA-256 hash of the customer-supplied
2727 # encryption key that protects this resource.
2728 },
2729 &quot;sourceInstantSnapshotId&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique ID of the instant snapshot used to create this
2730 # snapshot. This value identifies the exact instant snapshot that was used to
2731 # create this snapshot. For example, if you created the snapshot from an
2732 # instant snapshot that was later deleted and recreated under the same name,
2733 # the source instant snapshot ID would identify the exact instant snapshot
2734 # that was used.
2735 &quot;sourceSnapshotSchedulePolicy&quot;: &quot;A String&quot;, # Output only. [Output Only] URL of the resource policy which created this
2736 # scheduled snapshot.
2737 &quot;sourceSnapshotSchedulePolicyId&quot;: &quot;A String&quot;, # Output only. [Output Only] ID of the resource policy which created this
2738 # scheduled snapshot.
2739 &quot;status&quot;: &quot;A String&quot;, # Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.
2740 &quot;storageBytes&quot;: &quot;A String&quot;, # Output only. [Output Only] A size of the storage used by the snapshot. As snapshots
2741 # share storage, this number is expected to change with snapshot
2742 # creation/deletion.
2743 &quot;storageBytesStatus&quot;: &quot;A String&quot;, # Output only. [Deprecated] Instead, check the storageBytes field. After
2744 # snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.
2745 # [Output Only] An indicator whether storageBytes is in a
2746 # stable state or it is being adjusted as a result of shared storage
2747 # reallocation. This status can either be unset, meaning the snapshot is
2748 # being created, or UP_TO_DATE, meaning the size of the snapshot
2749 # is up-to-date.
2750 &quot;storageLocations&quot;: [ # Cloud Storage bucket storage location of the snapshot (regional or
2751 # multi-regional).
2752 &quot;A String&quot;,
2753 ],
2754 },
2755 ],
2756 &quot;kind&quot;: &quot;compute#snapshotList&quot;, # Output only. Type of resource.
2757 &quot;nextPageToken&quot;: &quot;A String&quot;, # [Output Only] This token allows you to get the next page of results for
2758 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
2759 # the query parameter pageToken in the next list request.
2760 # Subsequent list requests will have their own nextPageToken to
2761 # continue paging through the results.
2762 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource.
2763 &quot;warning&quot;: { # [Output Only] Informational warning message.
2764 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
2765 # Engine returns NO_RESULTS_ON_PAGE if there
2766 # are no results in the response.
2767 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
2768 # value format. For example:
2769 #
2770 # &quot;data&quot;: [
2771 # {
2772 # &quot;key&quot;: &quot;scope&quot;,
2773 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
2774 # }
2775 {
2776 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
2777 # returned. For example, for warnings where there are no results in a list
2778 # request for a particular zone, this key might be scope and
2779 # the key value might be the zone name. Other examples might be a key
2780 # indicating a deprecated resource and a suggested replacement, or a
2781 # warning about invalid network settings (for example, if an instance
2782 # attempts to perform IP forwarding but is not enabled for IP forwarding).
2783 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
2784 },
2785 ],
2786 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
2787 },
2788 }</pre>
2789 </div>
2790
2791 <div class="method">
2792 <code class="details" id="list_next">list_next()</code>
2793 <pre>Retrieves the next page of results.
2794
2795 Args:
2796 previous_request: The request for the previous page. (required)
2797 previous_response: The response from the request for the previous page. (required)
2798
2799 Returns:
2800 A request object that you can call &#x27;execute()&#x27; on to request the next
2801 page. Returns None if there are no more items in the collection.
2802 </pre>
2803 </div>
2804
2805 <div class="method">
2806 <code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None, x__xgafv=None)</code>
2807 <pre>Sets the access control policy on the specified resource.
2808 Replaces any existing policy.
2809
2810 Args:
2811 project: string, Project ID for this request. (required)
2812 resource: string, Name or id of the resource for this request. (required)
2813 body: object, The request body.
2814 The object takes the form of:
2815
2816 {
2817 &quot;bindings&quot;: [ # Flatten Policy to create a backward compatible wire-format.
2818 # Deprecated. Use &#x27;policy&#x27; to specify bindings.
2819 { # Associates `members`, or principals, with a `role`.
2820 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
2821 #
2822 # If the condition evaluates to `true`, then this binding applies to the
2823 # current request.
2824 #
2825 # If the condition evaluates to `false`, then this binding does not apply to
2826 # the current request. However, a different role binding might grant the same
2827 # role to one or more of the principals in this binding.
2828 #
2829 # To learn which resources support conditions in their IAM policies, see the
2830 # [IAM
2831 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2832 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
2833 # are documented at https://github.com/google/cel-spec.
2834 #
2835 # Example (Comparison):
2836 #
2837 # title: &quot;Summary size limit&quot;
2838 # description: &quot;Determines if a summary is less than 100 chars&quot;
2839 # expression: &quot;document.summary.size() &lt; 100&quot;
2840 #
2841 # Example (Equality):
2842 #
2843 # title: &quot;Requestor is owner&quot;
2844 # description: &quot;Determines if requestor is the document owner&quot;
2845 # expression: &quot;document.owner == request.auth.claims.email&quot;
2846 #
2847 # Example (Logic):
2848 #
2849 # title: &quot;Public documents&quot;
2850 # description: &quot;Determine whether the document should be publicly visible&quot;
2851 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
2852 #
2853 # Example (Data Manipulation):
2854 #
2855 # title: &quot;Notification string&quot;
2856 # description: &quot;Create a notification string with a timestamp.&quot;
2857 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
2858 #
2859 # The exact variables and functions that may be referenced within an expression
2860 # are determined by the service that evaluates it. See the service
2861 # documentation for additional information.
2862 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
2863 # describes the expression, e.g. when hovered over it in a UI.
2864 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
2865 # syntax.
2866 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
2867 # reporting, e.g. a file name and a position in the file.
2868 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
2869 # its purpose. This can be used e.g. in UIs which allow to enter the
2870 # expression.
2871 },
2872 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
2873 # `members` can have the following values:
2874 #
2875 # * `allUsers`: A special identifier that represents anyone who is
2876 # on the internet; with or without a Google account.
2877 #
2878 # * `allAuthenticatedUsers`: A special identifier that represents anyone
2879 # who is authenticated with a Google account or a service account.
2880 # Does not include identities that come from external identity providers
2881 # (IdPs) through identity federation.
2882 #
2883 # * `user:{emailid}`: An email address that represents a specific Google
2884 # account. For example, `[email protected]` .
2885 #
2886 #
2887 # * `serviceAccount:{emailid}`: An email address that represents a Google
2888 # service account. For example,
2889 # `[email protected]`.
2890 #
2891 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
2892 # identifier for a
2893 # [Kubernetes service
2894 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
2895 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
2896 #
2897 # * `group:{emailid}`: An email address that represents a Google group.
2898 # For example, `[email protected]`.
2899 #
2900 #
2901 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
2902 # users of that domain. For example, `google.com` or `example.com`.
2903 #
2904 #
2905 #
2906 #
2907 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2908 # A single identity in a workforce identity pool.
2909 #
2910 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
2911 # All workforce identities in a group.
2912 #
2913 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2914 # All workforce identities with a specific attribute value.
2915 #
2916 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
2917 # All identities in a workforce identity pool.
2918 #
2919 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
2920 # A single identity in a workload identity pool.
2921 #
2922 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
2923 # A workload identity pool group.
2924 #
2925 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
2926 # All identities in a workload identity pool with a certain attribute.
2927 #
2928 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
2929 # All identities in a workload identity pool.
2930 #
2931 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
2932 # identifier) representing a user that has been recently deleted. For
2933 # example, `[email protected]?uid=123456789012345678901`. If the user is
2934 # recovered, this value reverts to `user:{emailid}` and the recovered user
2935 # retains the role in the binding.
2936 #
2937 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
2938 # unique identifier) representing a service account that has been recently
2939 # deleted. For example,
2940 # `[email protected]?uid=123456789012345678901`.
2941 # If the service account is undeleted, this value reverts to
2942 # `serviceAccount:{emailid}` and the undeleted service account retains the
2943 # role in the binding.
2944 #
2945 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
2946 # identifier) representing a Google group that has been recently
2947 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
2948 # the group is recovered, this value reverts to `group:{emailid}` and the
2949 # recovered group retains the role in the binding.
2950 #
2951 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
2952 # Deleted single identity in a workforce identity pool. For example,
2953 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
2954 &quot;A String&quot;,
2955 ],
2956 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
2957 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
2958 #
2959 # For an overview of the IAM roles and permissions, see the
2960 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
2961 # a list of the available pre-defined roles, see
2962 # [here](https://cloud.google.com/iam/docs/understanding-roles).
2963 },
2964 ],
2965 &quot;etag&quot;: &quot;A String&quot;, # Flatten Policy to create a backward compatible wire-format.
2966 # Deprecated. Use &#x27;policy&#x27; to specify the etag.
2967 &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
2968 # the policy is limited to a few 10s of KB. An empty policy is in general a
2969 # valid policy but certain services (like Projects) might reject them.
2970 # controls for Google Cloud resources.
2971 #
2972 #
2973 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
2974 # `members`, or principals, to a single `role`. Principals can be user
2975 # accounts, service accounts, Google groups, and domains (such as G Suite). A
2976 # `role` is a named list of permissions; each `role` can be an IAM predefined
2977 # role or a user-created custom role.
2978 #
2979 # For some types of Google Cloud resources, a `binding` can also specify a
2980 # `condition`, which is a logical expression that allows access to a resource
2981 # only if the expression evaluates to `true`. A condition can add constraints
2982 # based on attributes of the request, the resource, or both. To learn which
2983 # resources support conditions in their IAM policies, see the
2984 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
2985 #
2986 # **JSON example:**
2987 #
2988 # ```
2989 # {
2990 # &quot;bindings&quot;: [
2991 # {
2992 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
2993 # &quot;members&quot;: [
2994 # &quot;user:[email protected]&quot;,
2995 # &quot;group:[email protected]&quot;,
2996 # &quot;domain:google.com&quot;,
2997 # &quot;serviceAccount:[email protected]&quot;
2998 # ]
2999 # },
3000 # {
3001 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3002 # &quot;members&quot;: [
3003 # &quot;user:[email protected]&quot;
3004 # ],
3005 # &quot;condition&quot;: {
3006 # &quot;title&quot;: &quot;expirable access&quot;,
3007 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3008 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3009 # }
3010 # }
3011 # ],
3012 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3013 # &quot;version&quot;: 3
3014 # }
3015 # ```
3016 #
3017 # **YAML example:**
3018 #
3019 # ```
3020 # bindings:
3021 # - members:
3022 # - user:[email protected]
3023 # - group:[email protected]
3024 # - domain:google.com
3025 # - serviceAccount:[email protected]
3026 # role: roles/resourcemanager.organizationAdmin
3027 # - members:
3028 # - user:[email protected]
3029 # role: roles/resourcemanager.organizationViewer
3030 # condition:
3031 # title: expirable access
3032 # description: Does not grant access after Sep 2020
3033 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3034 # etag: BwWWja0YfJA=
3035 # version: 3
3036 # ```
3037 #
3038 # For a description of IAM and its features, see the
3039 # [IAM documentation](https://cloud.google.com/iam/docs/).
3040 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3041 { # Specifies the audit configuration for a service.
3042 # The configuration determines which permission types are logged, and what
3043 # identities, if any, are exempted from logging.
3044 # An AuditConfig must have one or more AuditLogConfigs.
3045 #
3046 # If there are AuditConfigs for both `allServices` and a specific service,
3047 # the union of the two AuditConfigs is used for that service: the log_types
3048 # specified in each AuditConfig are enabled, and the exempted_members in each
3049 # AuditLogConfig are exempted.
3050 #
3051 # Example Policy with multiple AuditConfigs:
3052 #
3053 # {
3054 # &quot;audit_configs&quot;: [
3055 # {
3056 # &quot;service&quot;: &quot;allServices&quot;,
3057 # &quot;audit_log_configs&quot;: [
3058 # {
3059 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3060 # &quot;exempted_members&quot;: [
3061 # &quot;user:[email protected]&quot;
3062 # ]
3063 # },
3064 # {
3065 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3066 # },
3067 # {
3068 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3069 # }
3070 # ]
3071 # },
3072 # {
3073 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3074 # &quot;audit_log_configs&quot;: [
3075 # {
3076 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3077 # },
3078 # {
3079 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3080 # &quot;exempted_members&quot;: [
3081 # &quot;user:[email protected]&quot;
3082 # ]
3083 # }
3084 # ]
3085 # }
3086 # ]
3087 # }
3088 #
3089 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3090 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3091 # `[email protected]` from DATA_WRITE logging.
3092 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3093 { # Provides the configuration for logging a type of permissions.
3094 # Example:
3095 #
3096 # {
3097 # &quot;audit_log_configs&quot;: [
3098 # {
3099 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3100 # &quot;exempted_members&quot;: [
3101 # &quot;user:[email protected]&quot;
3102 # ]
3103 # },
3104 # {
3105 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3106 # }
3107 # ]
3108 # }
3109 #
3110 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3111 # [email protected] from DATA_READ logging.
3112 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3113 # permission.
3114 # Follows the same format of Binding.members.
3115 &quot;A String&quot;,
3116 ],
3117 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3118 },
3119 ],
3120 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3121 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3122 # `allServices` is a special value that covers all services.
3123 },
3124 ],
3125 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3126 # may specify a `condition` that determines how and when the `bindings` are
3127 # applied. Each of the `bindings` must contain at least one principal.
3128 #
3129 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3130 # of these principals can be Google groups. Each occurrence of a principal
3131 # counts towards these limits. For example, if the `bindings` grant 50
3132 # different roles to `user:[email protected]`, and not to any other
3133 # principal, then you can add another 1,450 principals to the `bindings` in
3134 # the `Policy`.
3135 { # Associates `members`, or principals, with a `role`.
3136 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3137 #
3138 # If the condition evaluates to `true`, then this binding applies to the
3139 # current request.
3140 #
3141 # If the condition evaluates to `false`, then this binding does not apply to
3142 # the current request. However, a different role binding might grant the same
3143 # role to one or more of the principals in this binding.
3144 #
3145 # To learn which resources support conditions in their IAM policies, see the
3146 # [IAM
3147 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3148 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3149 # are documented at https://github.com/google/cel-spec.
3150 #
3151 # Example (Comparison):
3152 #
3153 # title: &quot;Summary size limit&quot;
3154 # description: &quot;Determines if a summary is less than 100 chars&quot;
3155 # expression: &quot;document.summary.size() &lt; 100&quot;
3156 #
3157 # Example (Equality):
3158 #
3159 # title: &quot;Requestor is owner&quot;
3160 # description: &quot;Determines if requestor is the document owner&quot;
3161 # expression: &quot;document.owner == request.auth.claims.email&quot;
3162 #
3163 # Example (Logic):
3164 #
3165 # title: &quot;Public documents&quot;
3166 # description: &quot;Determine whether the document should be publicly visible&quot;
3167 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3168 #
3169 # Example (Data Manipulation):
3170 #
3171 # title: &quot;Notification string&quot;
3172 # description: &quot;Create a notification string with a timestamp.&quot;
3173 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3174 #
3175 # The exact variables and functions that may be referenced within an expression
3176 # are determined by the service that evaluates it. See the service
3177 # documentation for additional information.
3178 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3179 # describes the expression, e.g. when hovered over it in a UI.
3180 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3181 # syntax.
3182 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3183 # reporting, e.g. a file name and a position in the file.
3184 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3185 # its purpose. This can be used e.g. in UIs which allow to enter the
3186 # expression.
3187 },
3188 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3189 # `members` can have the following values:
3190 #
3191 # * `allUsers`: A special identifier that represents anyone who is
3192 # on the internet; with or without a Google account.
3193 #
3194 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3195 # who is authenticated with a Google account or a service account.
3196 # Does not include identities that come from external identity providers
3197 # (IdPs) through identity federation.
3198 #
3199 # * `user:{emailid}`: An email address that represents a specific Google
3200 # account. For example, `[email protected]` .
3201 #
3202 #
3203 # * `serviceAccount:{emailid}`: An email address that represents a Google
3204 # service account. For example,
3205 # `[email protected]`.
3206 #
3207 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3208 # identifier for a
3209 # [Kubernetes service
3210 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3211 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3212 #
3213 # * `group:{emailid}`: An email address that represents a Google group.
3214 # For example, `[email protected]`.
3215 #
3216 #
3217 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3218 # users of that domain. For example, `google.com` or `example.com`.
3219 #
3220 #
3221 #
3222 #
3223 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3224 # A single identity in a workforce identity pool.
3225 #
3226 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3227 # All workforce identities in a group.
3228 #
3229 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3230 # All workforce identities with a specific attribute value.
3231 #
3232 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3233 # All identities in a workforce identity pool.
3234 #
3235 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3236 # A single identity in a workload identity pool.
3237 #
3238 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3239 # A workload identity pool group.
3240 #
3241 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3242 # All identities in a workload identity pool with a certain attribute.
3243 #
3244 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3245 # All identities in a workload identity pool.
3246 #
3247 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3248 # identifier) representing a user that has been recently deleted. For
3249 # example, `[email protected]?uid=123456789012345678901`. If the user is
3250 # recovered, this value reverts to `user:{emailid}` and the recovered user
3251 # retains the role in the binding.
3252 #
3253 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3254 # unique identifier) representing a service account that has been recently
3255 # deleted. For example,
3256 # `[email protected]?uid=123456789012345678901`.
3257 # If the service account is undeleted, this value reverts to
3258 # `serviceAccount:{emailid}` and the undeleted service account retains the
3259 # role in the binding.
3260 #
3261 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3262 # identifier) representing a Google group that has been recently
3263 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3264 # the group is recovered, this value reverts to `group:{emailid}` and the
3265 # recovered group retains the role in the binding.
3266 #
3267 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3268 # Deleted single identity in a workforce identity pool. For example,
3269 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3270 &quot;A String&quot;,
3271 ],
3272 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3273 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3274 #
3275 # For an overview of the IAM roles and permissions, see the
3276 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3277 # a list of the available pre-defined roles, see
3278 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3279 },
3280 ],
3281 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3282 # prevent simultaneous updates of a policy from overwriting each other.
3283 # It is strongly suggested that systems make use of the `etag` in the
3284 # read-modify-write cycle to perform policy updates in order to avoid race
3285 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3286 # systems are expected to put that etag in the request to `setIamPolicy` to
3287 # ensure that their change will be applied to the same version of the policy.
3288 #
3289 # **Important:** If you use IAM Conditions, you must include the `etag` field
3290 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3291 # you to overwrite a version `3` policy with a version `1` policy, and all of
3292 # the conditions in the version `3` policy are lost.
3293 &quot;version&quot;: 42, # Specifies the format of the policy.
3294 #
3295 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3296 # are rejected.
3297 #
3298 # Any operation that affects conditional role bindings must specify version
3299 # `3`. This requirement applies to the following operations:
3300 #
3301 # * Getting a policy that includes a conditional role binding
3302 # * Adding a conditional role binding to a policy
3303 # * Changing a conditional role binding in a policy
3304 # * Removing any role binding, with or without a condition, from a policy
3305 # that includes conditions
3306 #
3307 # **Important:** If you use IAM Conditions, you must include the `etag` field
3308 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3309 # you to overwrite a version `3` policy with a version `1` policy, and all of
3310 # the conditions in the version `3` policy are lost.
3311 #
3312 # If a policy does not include any conditions, operations on that policy may
3313 # specify any valid version or leave the field unset.
3314 #
3315 # To learn which resources support conditions in their IAM policies, see the
3316 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3317 },
3318 }
3319
3320 x__xgafv: string, V1 error format.
3321 Allowed values
3322 1 - v1 error format
3323 2 - v2 error format
3324
3325 Returns:
3326 An object of the form:
3327
3328 { # An Identity and Access Management (IAM) policy, which specifies access
3329 # controls for Google Cloud resources.
3330 #
3331 #
3332 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
3333 # `members`, or principals, to a single `role`. Principals can be user
3334 # accounts, service accounts, Google groups, and domains (such as G Suite). A
3335 # `role` is a named list of permissions; each `role` can be an IAM predefined
3336 # role or a user-created custom role.
3337 #
3338 # For some types of Google Cloud resources, a `binding` can also specify a
3339 # `condition`, which is a logical expression that allows access to a resource
3340 # only if the expression evaluates to `true`. A condition can add constraints
3341 # based on attributes of the request, the resource, or both. To learn which
3342 # resources support conditions in their IAM policies, see the
3343 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3344 #
3345 # **JSON example:**
3346 #
3347 # ```
3348 # {
3349 # &quot;bindings&quot;: [
3350 # {
3351 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
3352 # &quot;members&quot;: [
3353 # &quot;user:[email protected]&quot;,
3354 # &quot;group:[email protected]&quot;,
3355 # &quot;domain:google.com&quot;,
3356 # &quot;serviceAccount:[email protected]&quot;
3357 # ]
3358 # },
3359 # {
3360 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
3361 # &quot;members&quot;: [
3362 # &quot;user:[email protected]&quot;
3363 # ],
3364 # &quot;condition&quot;: {
3365 # &quot;title&quot;: &quot;expirable access&quot;,
3366 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
3367 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
3368 # }
3369 # }
3370 # ],
3371 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
3372 # &quot;version&quot;: 3
3373 # }
3374 # ```
3375 #
3376 # **YAML example:**
3377 #
3378 # ```
3379 # bindings:
3380 # - members:
3381 # - user:[email protected]
3382 # - group:[email protected]
3383 # - domain:google.com
3384 # - serviceAccount:[email protected]
3385 # role: roles/resourcemanager.organizationAdmin
3386 # - members:
3387 # - user:[email protected]
3388 # role: roles/resourcemanager.organizationViewer
3389 # condition:
3390 # title: expirable access
3391 # description: Does not grant access after Sep 2020
3392 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
3393 # etag: BwWWja0YfJA=
3394 # version: 3
3395 # ```
3396 #
3397 # For a description of IAM and its features, see the
3398 # [IAM documentation](https://cloud.google.com/iam/docs/).
3399 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
3400 { # Specifies the audit configuration for a service.
3401 # The configuration determines which permission types are logged, and what
3402 # identities, if any, are exempted from logging.
3403 # An AuditConfig must have one or more AuditLogConfigs.
3404 #
3405 # If there are AuditConfigs for both `allServices` and a specific service,
3406 # the union of the two AuditConfigs is used for that service: the log_types
3407 # specified in each AuditConfig are enabled, and the exempted_members in each
3408 # AuditLogConfig are exempted.
3409 #
3410 # Example Policy with multiple AuditConfigs:
3411 #
3412 # {
3413 # &quot;audit_configs&quot;: [
3414 # {
3415 # &quot;service&quot;: &quot;allServices&quot;,
3416 # &quot;audit_log_configs&quot;: [
3417 # {
3418 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3419 # &quot;exempted_members&quot;: [
3420 # &quot;user:[email protected]&quot;
3421 # ]
3422 # },
3423 # {
3424 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3425 # },
3426 # {
3427 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;
3428 # }
3429 # ]
3430 # },
3431 # {
3432 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;,
3433 # &quot;audit_log_configs&quot;: [
3434 # {
3435 # &quot;log_type&quot;: &quot;DATA_READ&quot;
3436 # },
3437 # {
3438 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
3439 # &quot;exempted_members&quot;: [
3440 # &quot;user:[email protected]&quot;
3441 # ]
3442 # }
3443 # ]
3444 # }
3445 # ]
3446 # }
3447 #
3448 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
3449 # logging. It also exempts `[email protected]` from DATA_READ logging, and
3450 # `[email protected]` from DATA_WRITE logging.
3451 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
3452 { # Provides the configuration for logging a type of permissions.
3453 # Example:
3454 #
3455 # {
3456 # &quot;audit_log_configs&quot;: [
3457 # {
3458 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
3459 # &quot;exempted_members&quot;: [
3460 # &quot;user:[email protected]&quot;
3461 # ]
3462 # },
3463 # {
3464 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;
3465 # }
3466 # ]
3467 # }
3468 #
3469 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
3470 # [email protected] from DATA_READ logging.
3471 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
3472 # permission.
3473 # Follows the same format of Binding.members.
3474 &quot;A String&quot;,
3475 ],
3476 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
3477 },
3478 ],
3479 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
3480 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
3481 # `allServices` is a special value that covers all services.
3482 },
3483 ],
3484 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally,
3485 # may specify a `condition` that determines how and when the `bindings` are
3486 # applied. Each of the `bindings` must contain at least one principal.
3487 #
3488 # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
3489 # of these principals can be Google groups. Each occurrence of a principal
3490 # counts towards these limits. For example, if the `bindings` grant 50
3491 # different roles to `user:[email protected]`, and not to any other
3492 # principal, then you can add another 1,450 principals to the `bindings` in
3493 # the `Policy`.
3494 { # Associates `members`, or principals, with a `role`.
3495 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
3496 #
3497 # If the condition evaluates to `true`, then this binding applies to the
3498 # current request.
3499 #
3500 # If the condition evaluates to `false`, then this binding does not apply to
3501 # the current request. However, a different role binding might grant the same
3502 # role to one or more of the principals in this binding.
3503 #
3504 # To learn which resources support conditions in their IAM policies, see the
3505 # [IAM
3506 # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3507 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
3508 # are documented at https://github.com/google/cel-spec.
3509 #
3510 # Example (Comparison):
3511 #
3512 # title: &quot;Summary size limit&quot;
3513 # description: &quot;Determines if a summary is less than 100 chars&quot;
3514 # expression: &quot;document.summary.size() &lt; 100&quot;
3515 #
3516 # Example (Equality):
3517 #
3518 # title: &quot;Requestor is owner&quot;
3519 # description: &quot;Determines if requestor is the document owner&quot;
3520 # expression: &quot;document.owner == request.auth.claims.email&quot;
3521 #
3522 # Example (Logic):
3523 #
3524 # title: &quot;Public documents&quot;
3525 # description: &quot;Determine whether the document should be publicly visible&quot;
3526 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
3527 #
3528 # Example (Data Manipulation):
3529 #
3530 # title: &quot;Notification string&quot;
3531 # description: &quot;Create a notification string with a timestamp.&quot;
3532 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
3533 #
3534 # The exact variables and functions that may be referenced within an expression
3535 # are determined by the service that evaluates it. See the service
3536 # documentation for additional information.
3537 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
3538 # describes the expression, e.g. when hovered over it in a UI.
3539 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
3540 # syntax.
3541 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
3542 # reporting, e.g. a file name and a position in the file.
3543 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
3544 # its purpose. This can be used e.g. in UIs which allow to enter the
3545 # expression.
3546 },
3547 &quot;members&quot;: [ # Specifies the principals requesting access for a Google Cloud resource.
3548 # `members` can have the following values:
3549 #
3550 # * `allUsers`: A special identifier that represents anyone who is
3551 # on the internet; with or without a Google account.
3552 #
3553 # * `allAuthenticatedUsers`: A special identifier that represents anyone
3554 # who is authenticated with a Google account or a service account.
3555 # Does not include identities that come from external identity providers
3556 # (IdPs) through identity federation.
3557 #
3558 # * `user:{emailid}`: An email address that represents a specific Google
3559 # account. For example, `[email protected]` .
3560 #
3561 #
3562 # * `serviceAccount:{emailid}`: An email address that represents a Google
3563 # service account. For example,
3564 # `[email protected]`.
3565 #
3566 # * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
3567 # identifier for a
3568 # [Kubernetes service
3569 # account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
3570 # For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
3571 #
3572 # * `group:{emailid}`: An email address that represents a Google group.
3573 # For example, `[email protected]`.
3574 #
3575 #
3576 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
3577 # users of that domain. For example, `google.com` or `example.com`.
3578 #
3579 #
3580 #
3581 #
3582 # * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3583 # A single identity in a workforce identity pool.
3584 #
3585 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
3586 # All workforce identities in a group.
3587 #
3588 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3589 # All workforce identities with a specific attribute value.
3590 #
3591 # * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:
3592 # All identities in a workforce identity pool.
3593 #
3594 # * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:
3595 # A single identity in a workload identity pool.
3596 #
3597 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:
3598 # A workload identity pool group.
3599 #
3600 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
3601 # All identities in a workload identity pool with a certain attribute.
3602 #
3603 # * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:
3604 # All identities in a workload identity pool.
3605 #
3606 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
3607 # identifier) representing a user that has been recently deleted. For
3608 # example, `[email protected]?uid=123456789012345678901`. If the user is
3609 # recovered, this value reverts to `user:{emailid}` and the recovered user
3610 # retains the role in the binding.
3611 #
3612 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
3613 # unique identifier) representing a service account that has been recently
3614 # deleted. For example,
3615 # `[email protected]?uid=123456789012345678901`.
3616 # If the service account is undeleted, this value reverts to
3617 # `serviceAccount:{emailid}` and the undeleted service account retains the
3618 # role in the binding.
3619 #
3620 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
3621 # identifier) representing a Google group that has been recently
3622 # deleted. For example, `[email protected]?uid=123456789012345678901`. If
3623 # the group is recovered, this value reverts to `group:{emailid}` and the
3624 # recovered group retains the role in the binding.
3625 #
3626 # * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:
3627 # Deleted single identity in a workforce identity pool. For example,
3628 # `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
3629 &quot;A String&quot;,
3630 ],
3631 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals.
3632 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
3633 #
3634 # For an overview of the IAM roles and permissions, see the
3635 # [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For
3636 # a list of the available pre-defined roles, see
3637 # [here](https://cloud.google.com/iam/docs/understanding-roles).
3638 },
3639 ],
3640 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
3641 # prevent simultaneous updates of a policy from overwriting each other.
3642 # It is strongly suggested that systems make use of the `etag` in the
3643 # read-modify-write cycle to perform policy updates in order to avoid race
3644 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
3645 # systems are expected to put that etag in the request to `setIamPolicy` to
3646 # ensure that their change will be applied to the same version of the policy.
3647 #
3648 # **Important:** If you use IAM Conditions, you must include the `etag` field
3649 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3650 # you to overwrite a version `3` policy with a version `1` policy, and all of
3651 # the conditions in the version `3` policy are lost.
3652 &quot;version&quot;: 42, # Specifies the format of the policy.
3653 #
3654 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
3655 # are rejected.
3656 #
3657 # Any operation that affects conditional role bindings must specify version
3658 # `3`. This requirement applies to the following operations:
3659 #
3660 # * Getting a policy that includes a conditional role binding
3661 # * Adding a conditional role binding to a policy
3662 # * Changing a conditional role binding in a policy
3663 # * Removing any role binding, with or without a condition, from a policy
3664 # that includes conditions
3665 #
3666 # **Important:** If you use IAM Conditions, you must include the `etag` field
3667 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
3668 # you to overwrite a version `3` policy with a version `1` policy, and all of
3669 # the conditions in the version `3` policy are lost.
3670 #
3671 # If a policy does not include any conditions, operations on that policy may
3672 # specify any valid version or leave the field unset.
3673 #
3674 # To learn which resources support conditions in their IAM policies, see the
3675 # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
3676 }</pre>
3677 </div>
3678
3679 <div class="method">
3680 <code class="details" id="setLabels">setLabels(project, resource, body=None, x__xgafv=None)</code>
3681 <pre>Sets the labels on a snapshot. To learn more about labels, read theLabeling
3682 Resources documentation.
3683
3684 Args:
3685 project: string, Project ID for this request. (required)
3686 resource: string, Name or id of the resource for this request. (required)
3687 body: object, The request body.
3688 The object takes the form of:
3689
3690 {
3691 &quot;labelFingerprint&quot;: &quot;A String&quot;, # The fingerprint of the previous set of labels for this resource,
3692 # used to detect conflicts. The fingerprint is initially generated by Compute
3693 # Engine and changes after every request to modify or update labels. You must
3694 # always provide an up-to-date fingerprint hash when updating or changing
3695 # labels, otherwise the request will fail with error412 conditionNotMet. Make a get() request to the
3696 # resource to get the latest fingerprint.
3697 &quot;labels&quot;: { # A list of labels to apply for this resource. Each label must comply with
3698 # the
3699 # requirements for labels. For example,&quot;webserver-frontend&quot;: &quot;images&quot;. A label value can also be
3700 # empty (e.g. &quot;my-label&quot;: &quot;&quot;).
3701 &quot;a_key&quot;: &quot;A String&quot;,
3702 },
3703 }
3704
3705 x__xgafv: string, V1 error format.
3706 Allowed values
3707 1 - v1 error format
3708 2 - v2 error format
3709
3710 Returns:
3711 An object of the form:
3712
3713 { # Represents an Operation resource.
3714 #
3715 # Google Compute Engine has three Operation resources:
3716 #
3717 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
3718 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
3719 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
3720 #
3721 # You can use an operation resource to manage asynchronous API requests.
3722 # For more information, readHandling
3723 # API responses.
3724 #
3725 # Operations can be global, regional or zonal.
3726 #
3727 # - For global operations, use the `globalOperations`
3728 # resource.
3729 # - For regional operations, use the
3730 # `regionOperations` resource.
3731 # - For zonal operations, use
3732 # the `zoneOperations` resource.
3733 #
3734 #
3735 #
3736 # For more information, read
3737 # Global, Regional, and Zonal Resources.
3738 #
3739 # Note that completed Operation resources have a limited
3740 # retention period.
3741 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
3742 # Not present otherwise.
3743 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
3744 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
3745 # set when the operation is created.
3746 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
3747 # text format.
3748 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
3749 # this field will be populated.
3750 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
3751 # operation.
3752 {
3753 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
3754 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
3755 # details. There is a set of defined message types to use for providing
3756 # details.The syntax depends on the error code. For example,
3757 # QuotaExceededInfo will have details when the error code is
3758 # QUOTA_EXCEEDED.
3759 {
3760 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
3761 #
3762 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
3763 # is not enabled:
3764 #
3765 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
3766 # &quot;domain&quot;: &quot;googleapis.com&quot;
3767 # &quot;metadata&quot;: {
3768 # &quot;resource&quot;: &quot;projects/123&quot;,
3769 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
3770 # }
3771 # }
3772 #
3773 # This response indicates that the pubsub.googleapis.com API is not enabled.
3774 #
3775 # Example of an error that is returned when attempting to create a Spanner
3776 # instance in a region that is out of stock:
3777 #
3778 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
3779 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
3780 # &quot;metadata&quot;: {
3781 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
3782 # }
3783 # }
3784 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
3785 # is typically the registered service name of the tool or product that
3786 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
3787 # generated by some common infrastructure, the error domain must be a
3788 # globally unique value that identifies the infrastructure. For Google API
3789 # infrastructure, the error domain is &quot;googleapis.com&quot;.
3790 &quot;metadatas&quot;: { # Additional structured details about this error.
3791 #
3792 # Keys must match a regular expression of `a-z+` but should
3793 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
3794 # length. When identifying the current value of an exceeded limit, the units
3795 # should be contained in the key, not the value. For example, rather than
3796 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
3797 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
3798 # instances that can be created in a single (batch) request.
3799 &quot;a_key&quot;: &quot;A String&quot;,
3800 },
3801 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
3802 # proximate cause of the error. Error reasons are unique within a particular
3803 # domain of errors. This should be at most 63 characters and match a
3804 # regular expression of `A-Z+[A-Z0-9]`, which represents
3805 # UPPER_SNAKE_CASE.
3806 },
3807 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
3808 #
3809 # For example, if a quota check failed with an error indicating the calling
3810 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
3811 # directly to the right place in the developer console to flip the bit.
3812 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
3813 { # Describes a URL link.
3814 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
3815 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
3816 },
3817 ],
3818 },
3819 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
3820 # which can be attached to an RPC error.
3821 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
3822 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
3823 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
3824 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
3825 },
3826 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
3827 &quot;dimensions&quot;: { # The map holding related quota dimensions.
3828 &quot;a_key&quot;: &quot;A String&quot;,
3829 },
3830 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
3831 # type or metric.
3832 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
3833 # or metric.
3834 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
3835 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
3836 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
3837 },
3838 },
3839 ],
3840 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
3841 # This property is optional.
3842 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
3843 },
3844 ],
3845 },
3846 &quot;getVersionOperationMetadata&quot;: {
3847 &quot;inlineSbomInfo&quot;: {
3848 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
3849 # appropriate identifiers.
3850 &quot;a_key&quot;: &quot;A String&quot;,
3851 },
3852 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
3853 # identifiers.
3854 &quot;a_key&quot;: &quot;A String&quot;,
3855 },
3856 },
3857 },
3858 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
3859 # message that was returned, such as `NOT FOUND`.
3860 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
3861 # status code that was returned. For example, a `404` means the
3862 # resource was not found.
3863 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
3864 # defined by the server.
3865 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
3866 # This value is inRFC3339
3867 # text format.
3868 &quot;instancesBulkInsertOperationMetadata&quot;: {
3869 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
3870 # Example key: zones/us-central1-a
3871 &quot;a_key&quot;: {
3872 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
3873 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
3874 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
3875 # error.
3876 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
3877 # if the flow is rolling forward or rolling back.
3878 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
3879 },
3880 },
3881 },
3882 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
3883 # Operation resources.
3884 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
3885 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
3886 # group of operations results from a `bulkInsert` API request.
3887 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
3888 # `update`, or `delete`, and so on.
3889 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
3890 # There is no requirement that this be linear or support any granularity of
3891 # operations. This should not be used to guess when the operation will be
3892 # complete. This number should monotonically increase as the operation
3893 # progresses.
3894 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
3895 # applicable when performing regional operations.
3896 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
3897 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
3898 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
3899 # this field will contain information on all underlying zonal actions and
3900 # their state.
3901 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
3902 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
3903 # Example key: zones/us-central1-a
3904 &quot;a_key&quot;: {
3905 &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
3906 # populated.
3907 # different programming environments, including REST APIs and RPC APIs. It is
3908 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3909 # three pieces of data: error code, error message, and error details.
3910 #
3911 # You can find out more about this error model and how to work with it in the
3912 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3913 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
3914 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
3915 # message types for APIs to use.
3916 {
3917 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3918 },
3919 ],
3920 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
3921 # user-facing error message should be localized and sent in the
3922 # google.rpc.Status.details field, or localized by the client.
3923 },
3924 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
3925 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
3926 },
3927 },
3928 },
3929 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
3930 # This value is inRFC3339
3931 # text format.
3932 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
3933 # following:
3934 # `PENDING`, `RUNNING`, or `DONE`.
3935 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
3936 # operation.
3937 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
3938 # of the target resource.
3939 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
3940 # operations related to creating a snapshot, this points to the disk
3941 # that the snapshot was created from.
3942 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
3943 # `[email protected]` or
3944 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
3945 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
3946 # operation, this field will be populated.
3947 {
3948 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
3949 # Engine returns NO_RESULTS_ON_PAGE if there
3950 # are no results in the response.
3951 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
3952 # value format. For example:
3953 #
3954 # &quot;data&quot;: [
3955 # {
3956 # &quot;key&quot;: &quot;scope&quot;,
3957 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
3958 # }
3959 {
3960 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
3961 # returned. For example, for warnings where there are no results in a list
3962 # request for a particular zone, this key might be scope and
3963 # the key value might be the zone name. Other examples might be a key
3964 # indicating a deprecated resource and a suggested replacement, or a
3965 # warning about invalid network settings (for example, if an instance
3966 # attempts to perform IP forwarding but is not enabled for IP forwarding).
3967 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
3968 },
3969 ],
3970 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
3971 },
3972 ],
3973 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
3974 # applicable when performing per-zone operations.
3975 }</pre>
3976 </div>
3977
3978 <div class="method">
3979 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code>
3980 <pre>Returns permissions that a caller has on the specified resource.
3981
3982 Args:
3983 project: string, Project ID for this request. (required)
3984 resource: string, Name or id of the resource for this request. (required)
3985 body: object, The request body.
3986 The object takes the form of:
3987
3988 {
3989 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with
3990 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
3991 &quot;A String&quot;,
3992 ],
3993 }
3994
3995 x__xgafv: string, V1 error format.
3996 Allowed values
3997 1 - v1 error format
3998 2 - v2 error format
3999
4000 Returns:
4001 An object of the form:
4002
4003 {
4004 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
4005 # allowed.
4006 &quot;A String&quot;,
4007 ],
4008 }</pre>
4009 </div>
4010
4011 <div class="method">
4012 <code class="details" id="updateKmsKey">updateKmsKey(project, snapshot, body=None, requestId=None, x__xgafv=None)</code>
4013 <pre>Rotates the customer-managed
4014 encryption key to the latest version for the specified snapshot.
4015
4016 Args:
4017 project: string, Project ID for this request. (required)
4018 snapshot: string, Name of the snapshot resource to update. Should conform to RFC1035. (required)
4019 body: object, The request body.
4020 The object takes the form of:
4021
4022 {
4023 &quot;kmsKeyName&quot;: &quot;A String&quot;, # Optional. The new KMS key to replace the current one on the snapshot. If empty, the
4024 # snapshot will be re-encrypted using the primary version of the snapshot&#x27;s
4025 # current KMS key.
4026 #
4027 # The KMS key can be provided in the following formats:
4028 #
4029 #
4030 # - projects/project_id/locations/region/keyRings/key_ring/cryptoKeys/key
4031 }
4032
4033 requestId: string, An optional request ID to identify requests. Specify a unique request ID so
4034 that if you must retry your request, the server will know to ignore the
4035 request if it has already been completed.
4036
4037 For example, consider a situation where you make an initial request and
4038 the request times out. If you make the request again with the same
4039 request ID, the server can check if original operation with the same
4040 request ID was received, and if so, will ignore the second request. This
4041 prevents clients from accidentally creating duplicate commitments.
4042
4043 The request ID must be
4044 a valid UUID with the exception that zero UUID is not supported
4045 (00000000-0000-0000-0000-000000000000).
4046 x__xgafv: string, V1 error format.
4047 Allowed values
4048 1 - v1 error format
4049 2 - v2 error format
4050
4051 Returns:
4052 An object of the form:
4053
4054 { # Represents an Operation resource.
4055 #
4056 # Google Compute Engine has three Operation resources:
4057 #
4058 # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
4059 # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
4060 # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
4061 #
4062 # You can use an operation resource to manage asynchronous API requests.
4063 # For more information, readHandling
4064 # API responses.
4065 #
4066 # Operations can be global, regional or zonal.
4067 #
4068 # - For global operations, use the `globalOperations`
4069 # resource.
4070 # - For regional operations, use the
4071 # `regionOperations` resource.
4072 # - For zonal operations, use
4073 # the `zoneOperations` resource.
4074 #
4075 #
4076 #
4077 # For more information, read
4078 # Global, Regional, and Zonal Resources.
4079 #
4080 # Note that completed Operation resources have a limited
4081 # retention period.
4082 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
4083 # Not present otherwise.
4084 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
4085 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
4086 # set when the operation is created.
4087 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
4088 # text format.
4089 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
4090 # this field will be populated.
4091 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
4092 # operation.
4093 {
4094 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
4095 &quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
4096 # details. There is a set of defined message types to use for providing
4097 # details.The syntax depends on the error code. For example,
4098 # QuotaExceededInfo will have details when the error code is
4099 # QUOTA_EXCEEDED.
4100 {
4101 &quot;errorInfo&quot;: { # Describes the cause of the error with structured details.
4102 #
4103 # Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
4104 # is not enabled:
4105 #
4106 # { &quot;reason&quot;: &quot;API_DISABLED&quot;
4107 # &quot;domain&quot;: &quot;googleapis.com&quot;
4108 # &quot;metadata&quot;: {
4109 # &quot;resource&quot;: &quot;projects/123&quot;,
4110 # &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
4111 # }
4112 # }
4113 #
4114 # This response indicates that the pubsub.googleapis.com API is not enabled.
4115 #
4116 # Example of an error that is returned when attempting to create a Spanner
4117 # instance in a region that is out of stock:
4118 #
4119 # { &quot;reason&quot;: &quot;STOCKOUT&quot;
4120 # &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
4121 # &quot;metadata&quot;: {
4122 # &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
4123 # }
4124 # }
4125 &quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
4126 # is typically the registered service name of the tool or product that
4127 # generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
4128 # generated by some common infrastructure, the error domain must be a
4129 # globally unique value that identifies the infrastructure. For Google API
4130 # infrastructure, the error domain is &quot;googleapis.com&quot;.
4131 &quot;metadatas&quot;: { # Additional structured details about this error.
4132 #
4133 # Keys must match a regular expression of `a-z+` but should
4134 # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
4135 # length. When identifying the current value of an exceeded limit, the units
4136 # should be contained in the key, not the value. For example, rather than
4137 # `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
4138 # `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
4139 # instances that can be created in a single (batch) request.
4140 &quot;a_key&quot;: &quot;A String&quot;,
4141 },
4142 &quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
4143 # proximate cause of the error. Error reasons are unique within a particular
4144 # domain of errors. This should be at most 63 characters and match a
4145 # regular expression of `A-Z+[A-Z0-9]`, which represents
4146 # UPPER_SNAKE_CASE.
4147 },
4148 &quot;help&quot;: { # Provides links to documentation or for performing an out of band action.
4149 #
4150 # For example, if a quota check failed with an error indicating the calling
4151 # project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
4152 # directly to the right place in the developer console to flip the bit.
4153 &quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
4154 { # Describes a URL link.
4155 &quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
4156 &quot;url&quot;: &quot;A String&quot;, # The URL of the link.
4157 },
4158 ],
4159 },
4160 &quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user
4161 # which can be attached to an RPC error.
4162 &quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
4163 # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
4164 # Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
4165 &quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
4166 },
4167 &quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota.
4168 &quot;dimensions&quot;: { # The map holding related quota dimensions.
4169 &quot;a_key&quot;: &quot;A String&quot;,
4170 },
4171 &quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
4172 # type or metric.
4173 &quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
4174 # or metric.
4175 &quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
4176 &quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
4177 &quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
4178 },
4179 },
4180 ],
4181 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
4182 # This property is optional.
4183 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
4184 },
4185 ],
4186 },
4187 &quot;getVersionOperationMetadata&quot;: {
4188 &quot;inlineSbomInfo&quot;: {
4189 &quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
4190 # appropriate identifiers.
4191 &quot;a_key&quot;: &quot;A String&quot;,
4192 },
4193 &quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
4194 # identifiers.
4195 &quot;a_key&quot;: &quot;A String&quot;,
4196 },
4197 },
4198 },
4199 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
4200 # message that was returned, such as `NOT FOUND`.
4201 &quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
4202 # status code that was returned. For example, a `404` means the
4203 # resource was not found.
4204 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
4205 # defined by the server.
4206 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
4207 # This value is inRFC3339
4208 # text format.
4209 &quot;instancesBulkInsertOperationMetadata&quot;: {
4210 &quot;perLocationStatus&quot;: { # Status information per location (location name is key).
4211 # Example key: zones/us-central1-a
4212 &quot;a_key&quot;: {
4213 &quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
4214 &quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
4215 &quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
4216 # error.
4217 &quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
4218 # if the flow is rolling forward or rolling back.
4219 &quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
4220 },
4221 },
4222 },
4223 &quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
4224 # Operation resources.
4225 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
4226 &quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
4227 # group of operations results from a `bulkInsert` API request.
4228 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
4229 # `update`, or `delete`, and so on.
4230 &quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
4231 # There is no requirement that this be linear or support any granularity of
4232 # operations. This should not be used to guess when the operation will be
4233 # complete. This number should monotonically increase as the operation
4234 # progresses.
4235 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
4236 # applicable when performing regional operations.
4237 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
4238 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
4239 &quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
4240 # this field will contain information on all underlying zonal actions and
4241 # their state.
4242 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
4243 &quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
4244 # Example key: zones/us-central1-a
4245 &quot;a_key&quot;: {
4246 &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
4247 # populated.
4248 # different programming environments, including REST APIs and RPC APIs. It is
4249 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4250 # three pieces of data: error code, error message, and error details.
4251 #
4252 # You can find out more about this error model and how to work with it in the
4253 # [API Design Guide](https://cloud.google.com/apis/design/errors).
4254 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
4255 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
4256 # message types for APIs to use.
4257 {
4258 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
4259 },
4260 ],
4261 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
4262 # user-facing error message should be localized and sent in the
4263 # google.rpc.Status.details field, or localized by the client.
4264 },
4265 &quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
4266 # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
4267 },
4268 },
4269 },
4270 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
4271 # This value is inRFC3339
4272 # text format.
4273 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
4274 # following:
4275 # `PENDING`, `RUNNING`, or `DONE`.
4276 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
4277 # operation.
4278 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
4279 # of the target resource.
4280 &quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
4281 # operations related to creating a snapshot, this points to the disk
4282 # that the snapshot was created from.
4283 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
4284 # `[email protected]` or
4285 # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
4286 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
4287 # operation, this field will be populated.
4288 {
4289 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
4290 # Engine returns NO_RESULTS_ON_PAGE if there
4291 # are no results in the response.
4292 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
4293 # value format. For example:
4294 #
4295 # &quot;data&quot;: [
4296 # {
4297 # &quot;key&quot;: &quot;scope&quot;,
4298 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
4299 # }
4300 {
4301 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
4302 # returned. For example, for warnings where there are no results in a list
4303 # request for a particular zone, this key might be scope and
4304 # the key value might be the zone name. Other examples might be a key
4305 # indicating a deprecated resource and a suggested replacement, or a
4306 # warning about invalid network settings (for example, if an instance
4307 # attempts to perform IP forwarding but is not enabled for IP forwarding).
4308 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
4309 },
4310 ],
4311 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
4312 },
4313 ],
4314 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
4315 # applicable when performing per-zone operations.
4316 }</pre>
4317 </div>
4318
4319 </body></html>