Debian Codegraph @

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